Claude Code MCP tool that auto-generates help documentation for web applications
Project description
KodaDocs
AI-generated help docs for your web app — in minutes, not weeks.
KodaDocs is an open-source Claude Code MCP tool. Install it, tell Claude "Generate docs for my app", and get a complete help center with annotated screenshots and AI-written articles. Free to self-host. $12/mo for hosted deploy to yourapp.kodadocs.com.
Quick Start
pip install kodadocs
playwright install chromium
Or run without installing:
uvx kodadocs --help
Add the MCP server to your Claude Code config (~/.claude/settings.json):
{
"mcpServers": {
"kodadocs": {
"command": "uvx",
"args": ["kodadocs", "mcp"]
}
}
}
Then tell Claude:
"Generate help docs for my app"
Claude reads your code, captures screenshots, writes documentation, and assembles a VitePress help center — all through MCP tools.
What Claude Does (via MCP tools)
| Phase | What happens |
|---|---|
| Discovery | Detects framework, discovers routes from code |
| Capture | Launches headless browser, authenticates, captures screenshots |
| Annotation | Draws numbered callouts on UI elements |
| Doc Writing | Claude writes all articles directly (Getting Started, Feature Guides, FAQ, Troubleshooting) |
| Assembly | Assembles VitePress site with branding, search, and mobile layout |
| Deploy | Deploys to Cloudflare, Vercel, Netlify, GitHub Pages, or kodadocs.com |
MCP Tools
| Tool | Description |
|---|---|
detect_framework |
Auto-detect web framework from project files |
capture_screenshots |
Headless browser capture with auth and validation |
annotate_screenshots |
Pillow numbered callouts + PII blur |
assemble_vitepress |
Build complete VitePress site from articles + screenshots |
deploy_site |
Deploy to hosting provider |
save_manifest |
Persist pipeline state |
load_manifest |
Load pipeline state |
Claude Code Skill
KodaDocs includes a skill file that teaches Claude how to orchestrate the full pipeline. To install it, copy skill/kodadocs.md into your project's .claude/skills/ directory:
mkdir -p .claude/skills
cp skill/kodadocs.md .claude/skills/kodadocs.md
Free vs Pro
| Free | Pro ($12/mo) | |
|---|---|---|
| Generation | Unlimited | Unlimited |
| Output | Local ./docs/ folder |
Local + one-command deploy |
| Hosting | Self-host (Vercel/Netlify/etc.) | yourapp.kodadocs.com |
| Custom domain | No | help.yourapp.com via CNAME |
| Branding | "Powered by KodaDocs" badge | Badge removable |
Users bring their own Anthropic API key — generation is never gated.
API Key
KodaDocs requires an Anthropic API key to generate documentation.
With Claude Code (MCP): The API key is provided automatically — no setup needed.
With the CLI: Set the key in your environment or in a .env file in your project root:
export ANTHROPIC_API_KEY=sk-ant-...
Or create a .env file in your project directory:
ANTHROPIC_API_KEY=sk-ant-...
KodaDocs loads .env automatically — no extra dependencies required.
CLI
KodaDocs also has CLI commands for direct usage without Claude Code:
kodadocs generate . # Run full pipeline
kodadocs generate . --url http://localhost:3000 # Override app URL
kodadocs deploy . --provider cloudflare # Deploy to provider
kodadocs init . # Interactive setup wizard
kodadocs config . # View/update config
kodadocs mcp # Start MCP server
License
MIT
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file kodadocs-0.1.0.tar.gz.
File metadata
- Download URL: kodadocs-0.1.0.tar.gz
- Upload date:
- Size: 166.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.9.28 {"installer":{"name":"uv","version":"0.9.28","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
39bff198fcf003d757ecdb741c0d0d4422bf264794636e8a874676c76f87b995
|
|
| MD5 |
daddb0877c3fb4b51eebaf29c961d419
|
|
| BLAKE2b-256 |
f8ee06f3369a1f8196750aed3407251d155309fa2fab2a0e68e3c6aaf731ed47
|
File details
Details for the file kodadocs-0.1.0-py3-none-any.whl.
File metadata
- Download URL: kodadocs-0.1.0-py3-none-any.whl
- Upload date:
- Size: 61.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.9.28 {"installer":{"name":"uv","version":"0.9.28","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
571dada0e4ec2932f13d9013919495d08ed10ee551115c392c12dfa586b2b99f
|
|
| MD5 |
f282501ed79308c7119b2381dbb4cf35
|
|
| BLAKE2b-256 |
239811c8948b790a7fc3fefb300b1eff269de5382c76ab1f6ef451430f197dcf
|