agentleFS
Sign inStart free
emaraschioemaraschio/cursor-commands/.cursor/skill-contracts/generate-api-docs/SKILL.md

generate-api-docs

Skill9 starsChanged 3 months agoMITView on GitHub

Generate API documentation from code

2 other projects use a version of this, 1 of them edited.

Adopted by

Most recently taken up by

The file

We split this skill into the rules it gives an agent

3 rules. About 0 are common, 3 are distinctive, and 0 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈3

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 0

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Create comprehensive API documentation for the current endpoints formatted as OpenAPI/Swagger specification or following the project's …

    line 8
  2. Distinctive:

    Document only endpoints that exist in code.

    line 44
  3. Distinctive:

    Use placeholder values in examples.

    line 45

≈ “Common” is an estimate: at least 1 in 5 of the 350,495 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

Overview

Create comprehensive API documentation for the current endpoints formatted as OpenAPI/Swagger specification or following the project's documentation standards.

Steps

  1. API Overview
    • Service description and purpose
    • Base URL and versioning information
    • Authentication and authorization requirements
    • Rate limiting and usage policies
  2. Endpoint Documentation
    • HTTP method and URL path
    • Request parameters (path, query, body)
    • Request/response schemas with data types
    • Example requests and responses
    • Possible error codes and messages
  3. Data Models
    • Define all data models and schemas
    • Include field descriptions and constraints
    • Show relationships between models
    • Provide example payloads
  4. Usage Examples
    • Common use case scenarios
    • SDK and client library examples
    • CURL command examples
    • Error handling examples

API Documentation Checklist

  • API overview complete
  • Endpoints documented
  • Data models defined
  • Usage examples provided
  • Documentation formatted per project standards

Guardrails

  • Document only endpoints that exist in code; do not invent endpoints, parameters, or responses.
  • Use placeholder values in examples; never expose real secrets or credentials.

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

Check your setup, free