# Write Meilisearch JS Tsdoc

> Write TSDoc for meilisearch-js public APIs. Use when documenting client methods, adding @experimental or @see tags, or updating JSDoc on SDK methods.

- Skill: `meilisearch/write-meilisearch-js-tsdoc` (Agent Skill)
- Install (CLI): `npx skillmds@latest add meilisearch/write-meilisearch-js-tsdoc`
- Raw SKILL.md: https://api.skillmd.com/api/skills/meilisearch/write-meilisearch-js-tsdoc/raw
- Safety review: pending
- Works with: Claude Code, Claude.ai, OpenAI Codex
- Category: Coding & Dev Tools
- Author: meilisearch (https://skillmd.com/u/meilisearch)
- Updated: 2026-09-17
- Page: https://skillmd.com/skills/meilisearch/write-meilisearch-js-tsdoc

---


# Write meilisearch-js TSDoc

## Shape

Match nearby methods in the same file. Typical experimental method:

```ts
/**
 * Get a dynamic search rule
 *
 * @param uid - Dynamic search rule UID
 * @returns Promise returning the dynamic search rule
 * @experimental
 * @see {@link https://www.meilisearch.com/docs/reference/api/search-rules/get-a-search-rule}
 */
```

Stable methods: omit `@experimental`. Keep `@param` / `@returns` as needed.

## Rules

- Link the matching API reference page with `@see {@link https://www.meilisearch.com/docs/...}`
- Resolve URLs from https://www.meilisearch.com/docs/llms.txt (prefer current paths over aliases)
- Mark experimental APIs with `@experimental` only
- Do not put Meilisearch version requirements in method prose (hard to keep accurate)
- Do not add a trailing period on the summary line
- Do not invent docs URLs; if no page exists, link the closest related API reference page

## Check

- `pnpm style:fix` (TSDoc lint runs via oxlint)