Appearance
Claude Code Integration
The recommended way to use KodaDocs is through Claude Code's MCP (Model Context Protocol) integration. This gives Claude direct access to all KodaDocs pipeline tools, letting it orchestrate the entire documentation process intelligently.
Setup
Add the KodaDocs MCP server to your Claude Code settings file at ~/.claude/settings.json:
json
{
"mcpServers": {
"kodadocs": {
"command": "uvx",
"args": ["kodadocs", "mcp"]
}
}
}That's it. Claude Code will automatically connect to the KodaDocs MCP server when you start a session.
Available MCP Tools
Claude has access to 9 specialized tools:
| Tool | Description |
|---|---|
detect_framework | Identifies your project's framework (Next.js, Django, etc.) |
discover_routes | Finds all routes and pages in your application |
analyze_codebase | Extracts code structure, error patterns, and data models |
capture_screenshots | Takes screenshots of each route with Playwright |
annotate_screenshots | Adds numbered callouts to interactive UI elements |
assemble_vitepress | Builds the final documentation site |
save_manifest | Saves pipeline progress for resumption |
load_manifest | Loads existing pipeline state |
deploy_site | Deploys to Cloudflare, Vercel, Netlify, or GitHub Pages |
Typical Workflow
When you tell Claude to generate docs, it follows this pipeline:
- Framework Detection — identifies your project type
- Route Discovery — finds all pages and endpoints via static analysis (with Playwright crawler fallback)
- Codebase Analysis — extracts functions, error patterns, and data models using tree-sitter
- Screenshot Capture — visits each route in a headless browser, captures full-page screenshots
- Annotation — adds numbered callout circles to buttons, links, headings, and other interactive elements
- Article Writing — Claude writes end-user documentation referencing specific UI elements
- Site Assembly — compiles everything into a VitePress static site
- Deployment (optional) — publishes to your hosting provider
Getting the Best Results
Here are tips for getting great documentation:
- Run your app locally before generating docs, so KodaDocs can capture screenshots. If your app isn't running, docs are generated from code analysis alone.
- Provide auth credentials if your app has protected pages — Claude will ask about this during setup.
- Review and edit the generated articles. KodaDocs provides confidence scores (0.0–1.0) — articles below 0.7 may need human review.
- Use incremental updates after your app changes — Claude can call
kodadocs updateto re-capture only changed routes.
Environment Variables
| Variable | Purpose |
|---|---|
ANTHROPIC_API_KEY | Required for AI-powered article generation |
KODADOCS_LICENSE_KEY | Required for Pro themes and hosted deployment |
ANTHROPIC_MODEL | Override the default AI model (default: claude-sonnet-4-6) |