@mhdd_24/api-documentation-mcp
v1.0.0
Published
Generate API documentation from code/specs
Maintainers
Readme
@mhdd_24/api-documentation-mcp
Generate API documentation from code/specs.
Same architecture as @mhdd_24/sublime-mcp.
Full documentation: docs/WIKI.md
How it works (30 seconds)
You (chat) → MCP client → api-documentation-mcp → API Documentation APIs / CLIs / local toolsPrerequisites
| Requirement | Notes | |-------------|--------| | Node.js 18+ | ESM TypeScript MCP server | | Credentials / CLIs | See environment variables below |
Install
Option A — npm (after publish)
npm install -g @mhdd_24/api-documentation-mcpOption B — npx
npx @mhdd_24/api-documentation-mcpOption C — clone and build
git clone https://github.com/Mhdd-24/API-Documentation-MCP.git
cd API-Documentation-MCP
npm install
npm run build
node dist/index.jsConfigure Cursor
Edit ~/.cursor/mcp.json:
{
"mcpServers": {
"apidoc": {
"command": "npx",
"args": ["-y", "@mhdd_24/api-documentation-mcp"],
"env": {
"PROJECT_ROOT": "..."
}
}
}
}Local development:
{
"command": "node",
"args": ["/absolute/path/to/API-Documentation-MCP/dist/index.js"]
}Environment variables
| Variable | Description |
|----------|-------------|
| PROJECT_ROOT | Default project/repository root |
Tools
| Tool | Description |
|------|-------------|
| apidoc_status | Health check for API Documentation MCP. |
| apidoc_from_openapi | Generate markdown docs from OpenAPI JSON. |
| apidoc_from_routes | Document routes listed as method path lines. |
License
ISC
