Document API endpoints as markdown agents can read

Scans your codebase for API routes and outputs a single markdown file with endpoint signatures, params, responses, and examples — formatted so Claude can actually use it.

Best for: Engineers who want their APIs discoverable to AI without writing docs twice.

Engineering / planning-thinkingatomicfor-engineersneeds-integrationfrom-repo

Source

Creator's repository · vercel-labs/cooking-school-feedback

View on GitHub

Skill file

Preview skill file
---
name: api-docs-generator
description: Generates agent-friendly markdown documentation for API routes. Use when user says "generate docs", "document this API", "create API documentation", or "make docs for my endpoints".
---

# API Docs Generator

TODO: Write the skill instructions here.

## Instructions

<!-- TODO: Add step-by-step instructions for how Claude should:
  1. Discover API route files in the project
  2. Analyze each route (methods, params, body, responses, errors)
  3. Read the TypeScript types
  4. Generate structured markdown docs
  5. Write the output file
-->

## Quality checklist

<!-- TODO: Add verification checks the skill should run before finishing -->