New: 97,000+ skills indexed from GitHub repos with 100+ stars · every skill safety-checkedBrowse top skillsTop skills
Esc to closeBrowse all skills
Submit a skillBrowse skills
Submit a skillBrowse skills

Agent skill

Meilisearch PHP PHPDoc Writer

by meilisearch in meilisearch/meilisearch-php

Documents public methods of the meilisearch-php SDK with compact PHPDoc, including @see links, @since tags and the experimental-feature notice.

MITAuto-check passedDevelopment

Install Meilisearch PHP PHPDoc Writer

skills CLI
$ npx skills add meilisearch/meilisearch-php --skill write-meilisearch-php-phpdoc -a claude-code

Project install by default; add -g for ~/.claude/skills/.

GitHub CLI
$ gh skill install meilisearch/meilisearch-php write-meilisearch-php-phpdoc --agent claude-code

Project scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).

Manual copy
$ git clone --depth 1 https://github.com/meilisearch/meilisearch-php.git skills-src && mkdir -p .claude/skills && cp -r skills-src/.agents/skills/write-meilisearch-php-phpdoc .claude/skills/write-meilisearch-php-phpdoc && rm -rf skills-src

Use ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.

Claude Code skills documentation · loads skills from .claude/skills/

Facts

Skill name
write-meilisearch-php-phpdoc
GitHub stars
757
Token cost
~569 tokens
SKILL.md length
184 words
Files
1
Skills in repo
1
Repo updated
First seen
Licence
MIT

At a glance

Documents public methods of the meilisearch-php SDK with compact PHPDoc, including @see links, @since tags and the experimental-feature notice.

  • Documenting a new client or endpoint method in meilisearch-php
  • SKILL.md covers Shape, Rules and Check
  • Calls docker and composer; reaches meilisearch.com
  • Adding @since or @see tags to public SDK methods

What it does

The skill sets conventions for PHPDoc on the SDK's public client, endpoint and delegate methods. Docblocks should match nearby methods in the same file and stay compact, adding only what the native PHP signature cannot say. The @param and @return tags are optional when the types are already complete, and are kept when they add phpstan refinements such as non-empty-string, array shapes or literal unions, or when a short description removes ambiguity. Two sample docblocks show a stable and an experimental method.

Each method links to its API reference page with @see, with URLs resolved from the Meilisearch docs llms.txt file and current canonical paths preferred over aliases. Version-gated APIs use an @since tag naming the Meilisearch version instead of putting the requirement in the summary. Experimental APIs carry a fixed notice that the feature may break without a major version. Docs URLs are never invented; if no page exists, the closest related reference page is linked. A docker compose command runs composer lint:fix and phpstan as the check.

When your agent uses it

  • Documenting a new client or endpoint method in meilisearch-php
  • Adding @since or @see tags to public SDK methods
  • Marking an experimental API method with the standard notice
  • Making a docblock match the wording and punctuation of neighboring methods

Example prompts

  • “Add PHPDoc to the new dynamic search rule methods and mark them as experimental.”
  • “Update the docblocks in this endpoint class so each method links to the right API reference page.”
  • “Add @since tags to the methods that need a minimum Meilisearch version, then run the lint and phpstan check.”

Requirements

  • Docker Compose to run the lint and phpstan check

What it can do on your machine

Read from SKILL.md and the folder at commit fbb4fa6. It shows what the files ask for, not the result of running them.

  • Tool permissions

    Pre-approves nothing: there is no allowed-tools line, so your agent's usual permission prompts apply.

    From allowed-tools in the SKILL.md frontmatter.

  • Runs code

    Shell commands in SKILL.md call:

    • docker
    • composer

    From the folder's file list and the shell code blocks in SKILL.md.

  • Network

    Hosts in commands or code, which the agent is likely to contact:

    • meilisearch.com

    From URLs in SKILL.md, links to its own repository left out.

  • Credentials

    Names no API keys, tokens, secrets or passwords.

    From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.

Context cost

Meilisearch PHP PHPDoc Writer loads about 569 tokens when it runs. Until then it costs about 51 tokens; SKILL.md has 184 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it
~51
When it runs · the whole SKILL.md, loaded when a task matches
~569

Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.

Safety

Auto-check passed

The automated check found no risky patterns in SKILL.md.

Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); files beside SKILL.md are not scanned.

SKILL.md

The full file from meilisearch/meilisearch-php at commit fbb4fa6, republished under its MIT licence (© meilisearch). 184 words, ~569 tokens.

Download SKILL.mdSave it as .claude/skills/write-meilisearch-php-phpdoc/SKILL.md (or your agent's skills folder).
name
write-meilisearch-php-phpdoc
description
Write PHPDoc for meilisearch-php public APIs. Use when documenting client, endpoint, or delegate methods, adding @since or @see tags, or updating PHPDoc on SDK public methods.

Write meilisearch-php PHPDoc

Shape

Match nearby methods in the same file. Prefer compact PHPDoc that adds information the native PHP signature cannot express.

Typical stable method:

php
/**
 * Get a dynamic search rule.
 *
 * @param non-empty-string $uid Dynamic search rule UID
 *
 * @since Meilisearch v1.41.0
 * @see https://www.meilisearch.com/docs/reference/api/search-rules/get-a-search-rule
 */
public function getDynamicSearchRule(string $uid): DynamicSearchRule

Typical experimental method:

php
/**
 * Get a dynamic search rule.
 *
 * This is an EXPERIMENTAL feature, which may break without a major version.
 *
 * @param non-empty-string $uid Dynamic search rule UID
 *
 * @since Meilisearch v1.41.0
 * @see https://www.meilisearch.com/docs/reference/api/search-rules/get-a-search-rule
 */
public function getDynamicSearchRule(string $uid): DynamicSearchRule

If the signature already fully expresses the types, @param and @return are optional. Keep them when they add phpstan refinements such as non-empty-string, array shapes, or literal unions, or when a short description prevents ambiguity.

Rules

  • Link the matching API reference page with @see https://www.meilisearch.com/docs/...
  • Resolve URLs from https://www.meilisearch.com/docs/llms.txt; prefer current canonical paths over aliases
  • Use @since Meilisearch vX.Y.Z for version-gated APIs instead of putting version requirements in the prose summary
  • Mark experimental APIs with the prose notice This is an EXPERIMENTAL feature, which may break without a major version.
  • Prefer phpstan-friendly refinements in docblocks: non-empty-string, array shapes, literal unions, typed lists
  • Do not add redundant @param or @return tags when the native type already says enough
  • Match nearby summary punctuation and wording in the same file
  • Do not invent docs URLs; if no page exists, link the closest related API reference page

Check

  • docker compose run --rm package bash -c "composer lint:fix && composer phpstan"

© meilisearch, MIT. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file

Files

Just SKILL.md in .agents/skills/write-meilisearch-php-phpdoc of meilisearch/meilisearch-php.

Open the folder on GitHubat commit fbb4fa6

Compare with similar skills

Meilisearch PHP PHPDoc Writer next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.

Meilisearch PHP PHPDoc Writer compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
Meilisearch PHP PHPDoc Writer this skillmeilisearch/meilisearch-php757—~569Automated safety check: PassMIT
Livewire Developmentcoollabsio/coolify63k—~964Automated safety check: PassMIT
WooCommerce Email Editor Developmentwoocommerce/woocommerce11k—~893Automated safety check: PassCustom licence
Ruoyi Plus AI Codingdromara/RuoYi-Cloud-Plus1.3k—~1.6kAutomated safety check: PassMIT
Diataxis Docs Writercalf-ai/calfkit-sdk1491 repos~3kAutomated safety check: PassApache-2.0
Repo Guardsimovilab/databus101—~1.3kAutomated safety check: PassApache-2.0

Similar skills

  • Livewire Development

    coollabsio/coolify

    A skill your agent uses for any task or question involving Livewire.

    63k GitHub stars~964 tokensUpdated today
    Backend & APIsAuto-check passed

  • WooCommerce Email Editor Development

    woocommerce/woocommerce

    Sets up a local environment for the WooCommerce block email editor, with a watcher, Mailpit email capture and build and test commands for its PHP and JS packages.

    11k GitHub stars~893 tokensUpdated today
    Backend & APIsAuto-check passed

  • Ruoyi Plus AI Coding

    dromara/RuoYi-Cloud-Plus

    在仓库内按代码生成器模板、项目 reference 文档和既有约定生成或修改代码。用于新增或修改 CRUD 模块、controller/service/mapper/BO/VO/entity、MyBatis-Plus/MPJ 查询、数据权限、缓存、翻译/JSON 增强、公共 common 模块能力、JavaDoc 注释，以及与后端接口配套的 Vue 3 + TypeScript…

    1.3k GitHub stars~1.6k tokensUpdated 9 days ago
    DevOps & CloudAuto-check passed

  • Diataxis Docs Writer

    calf-ai/calfkit-sdk

    Write or improve software documentation using the Diátaxis framework — four documentation types (tutorials, how-to guides, reference, explanation), each serving a different user need.

    149 GitHub starsUsed in 1 repo~3k tokens
    DevelopmentAuto-check passed

  • Repo Guard

    simovilab/databus

    Keep the databus repo clean as it grows — verify new/changed backend code meets the project's docstring, type-hint, and structural conventions, and update any docs the change made stale.

    101 GitHub stars~1.3k tokensUpdated 1 mo ago
    DevelopmentAuto-check passed

  • Adk Style

    google/adk-python

    Official

    Python style and codebase conventions for ADK (Agent Development Kit): private-by-default file visibility, imports, type hints, Pydantic v2 models, formatting, docstrings, logging, async I/O, file…

    22k GitHub stars~748 tokensUpdated today
    DevelopmentAuto-check passed

Works with

Categories

Questions about Meilisearch PHP PHPDoc Writer

What does Meilisearch PHP PHPDoc Writer do?

Documents public methods of the meilisearch-php SDK with compact PHPDoc, including @see links, @since tags and the experimental-feature notice. The skill sets conventions for PHPDoc on the SDK's public client, endpoint and delegate methods. Docblocks should match nearby methods in the same file and stay compact, adding only what the native PHP signature cannot say.

When should I use Meilisearch PHP PHPDoc Writer?

Meilisearch PHP PHPDoc Writer fits situations like: documenting a new client or endpoint method in meilisearch-php; adding @since or @see tags to public SDK methods; marking an experimental API method with the standard notice; making a docblock match the wording and punctuation of neighboring methods.

How do I install Meilisearch PHP PHPDoc Writer in Claude Code?

Run `npx skills add meilisearch/meilisearch-php --skill write-meilisearch-php-phpdoc -a claude-code`. Or copy the skill folder (.agents/skills/write-meilisearch-php-phpdoc in meilisearch/meilisearch-php) into .claude/skills/write-meilisearch-php-phpdoc in your project. Claude Code loads it when a task matches its description.

How do I install Meilisearch PHP PHPDoc Writer in Codex?

Run `npx skills add meilisearch/meilisearch-php --skill write-meilisearch-php-phpdoc -a codex`. Or copy the skill folder (.agents/skills/write-meilisearch-php-phpdoc in meilisearch/meilisearch-php) into .agents/skills/write-meilisearch-php-phpdoc in your project. Codex loads it when a task matches its description.

Can I use Meilisearch PHP PHPDoc Writer in Cursor, Gemini CLI or GitHub Copilot?

Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add meilisearch/meilisearch-php --skill write-meilisearch-php-phpdoc -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/write-meilisearch-php-phpdoc, .gemini/skills/write-meilisearch-php-phpdoc, .github/skills/write-meilisearch-php-phpdoc and .opencode/skills/write-meilisearch-php-phpdoc in your project.

What does Meilisearch PHP PHPDoc Writer need to run?

Going by SKILL.md and its folder, Meilisearch PHP PHPDoc Writer needs the command-line tools its instructions call (docker and composer). Our summary lists: Docker Compose to run the lint and phpstan check.

Does Meilisearch PHP PHPDoc Writer access the network?

SKILL.md names 1 domain. In commands or code: meilisearch.com; the agent is likely to contact it when it follows the instructions. This is read from the text; nothing was executed.

Is Meilisearch PHP PHPDoc Writer safe to install?

Our automated static check of SKILL.md found no risky patterns, such as piping downloads into a shell, reading credential files or hidden Unicode. It is not a guarantee. Review the folder before installing.

What licence does Meilisearch PHP PHPDoc Writer use?

Meilisearch PHP PHPDoc Writer is published under the MIT licence (the repository's licence). It allows redistribution, so the full SKILL.md is shown on this page.

How many tokens does Meilisearch PHP PHPDoc Writer use?

About 569 tokens (SKILL.md is roughly 2.3k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full.

What are the alternatives to Meilisearch PHP PHPDoc Writer?

Skills that share tags, products or a category with Meilisearch PHP PHPDoc Writer: Livewire Development (coollabsio/coolify, 63k stars), WooCommerce Email Editor Development (woocommerce/woocommerce, 11k stars), Ruoyi Plus AI Coding (dromara/RuoYi-Cloud-Plus, 1.3k stars) and Diataxis Docs Writer (calf-ai/calfkit-sdk, 149 stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains Meilisearch PHP PHPDoc Writer?

meilisearch (a GitHub organization) maintains it in meilisearch/meilisearch-php, which has 757 GitHub stars. The repository was last updated on September 23, 2026.

Source: meilisearch/meilisearch-php on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.