mcpbeat

API Doc

apify/api-doc

Create or update OpenAPI specifications and API documentation for Apify endpoints. Use when user says "add API endpoint", "create OpenAPI spec", "document this endpoint", "add code samples for API", "update API docs", or "api-doc". Handles OpenAPI YAML, schemas, code samples, and operation IDs.

2k tokens
context cost
the whole folder, loaded on every use
3
files
instructions only
0
copies elsewhere
how many repositories repackaged it
74
stars on the repo
on the repository, not the skill itself

Install

one command, takes just this skill from the repository 
npx skills add https://github.com/apify/apify-docs --skill api-doc

What comes with it

6 738 bytes besides the instruction
references/openapi-patterns.md
references/process.md

The instruction itself

2 sections, as written by the author

API documentation

Process

  • Identify change type - new endpoint, update endpoint, add code samples, or new schema
  • Follow OpenAPI file structure:
  • Paths in apify-api/openapi/paths/
  • Schemas in apify-api/openapi/components/schemas/
  • Code samples in apify-api/openapi/code_samples/{javascript,curl}/
  • Create or update files using naming conventions:
  • Path files: replace / with @ (e.g., request-queues@{queueId}.yaml)
  • Operation IDs: {objectName}_{httpMethod} in camelCase
  • Code sample filenames must match operationId
  • Register in main spec - add path $ref to apify-api/openapi/openapi.yaml
  • Validate - pnpm openapi:lint then pnpm api:rebuild

CRITICAL: API docs are generated, not hand-written. Never edit files in apify-api/docs/ directly.

For detailed patterns and examples, see .agents/skills/api-doc/references/openapi-patterns.md.

For edge cases and process notes, see .agents/skills/api-doc/references/process.md.

How to use it

Copy the folder

Take apify/api-doc from the repository into ~/.claude/skills for personal use, or into .claude/skills inside a project.

Check the name does not clash

The agent identifies a skill by the name field in its header. Two skills with the same name cannot sit side by side — one of them will be ignored.