Forerunner api docs
Skill derek-palmer/codeforerunner/plugins/codeforerunner/skills/forerunner-api-docs
Generate endpoint-level API documentation from route and handler files. Use when the user wants to document a public API or REST endpoints.From its SKILL.md
npx -y skills add derek-palmer/codeforerunner --skill forerunner-api-docsAssembled from the repository path, not quoted from the project. Check it against their README if it does not work.
2 things to look at
- no licenseNo license file was found in the repository. Code published without one is not open source by default, so using it at work is a question for whoever answers licensing questions where you are.
- 3 stars3 stars. Stars are a popularity signal and not a quality one, but at this level it is likely that nobody has read this closely except its author, and you would be relying on your own review.
SKILL.md
1.3 KB, as published. Nobody here has run it
forerunner-api-docs
Generates API reference documentation at the endpoint level. Requires scan result and all route/handler files in context.
Activate when
User asks to: document the API, generate API reference, write endpoint docs, create OpenAPI-style documentation.
Collect this context
- Scan result (run
/forerunner-scanfirst) - All route/handler files (every file the scan identified as an API entry point)
- Middleware files
- Auth and validation logic (for request/response shapes)
- Existing API docs (when updating)
Execute
Run forerunner generate --prompt-only api-docs — outputs the assembled prompt bundle to stdout. Read this output and execute the documentation task it describes.
Without CLI, get the prompt from:
src/codeforerunner/prompts/tasks/api-docs.mdsrc/codeforerunner/prompts/system/base.mdsrc/codeforerunner/prompts/partials/output-rules.md
Output
Structured API reference covering: endpoint list, HTTP method, path, auth requirement, request parameters/body, response shape, status codes. Write to docs/api.md or return as Markdown. Append ## Gaps for endpoints without sufficient source evidence.