document_api

Installation
SKILL.md

Document API

Use this skill to automatically map out and document your server's API surface area.

Inputs

  • Source Code: The directory or entry point (e.g., server.js).
  • Format: Preferred output (Markdown vs Swagger/OpenAPI).

Tooling Strategy

  • Use grep_search to find route definitions (e.g., .get(, @app.route).
  • Use view_file to understand request/response schemas.

Workflow

1. Analysis

  • Scan: Identify the server entry point (e.g., server.js, app.py).
  • Route Discovery: Trace route definitions (Express .get(), Flask @app.route, FastAPI decorators).
  • Parameters: specific inputs (Body, Query Params, Path Variables).
Installs
14
GitHub Stars
66
First Seen
Mar 20, 2026