Skip to main content

Claude Code MCP tool that auto-generates help documentation for web applications

Project description

KodaDocs

PyPI version License: MIT Python 3.12+

End-user ready help docs for your web app — generated in minutes, not written over weeks.

Most doc tools produce developer-facing references. KodaDocs produces the kind of help center your customers actually use: annotated screenshots, step-by-step guides, Getting Started walkthroughs, FAQ, and troubleshooting — all written in plain language, styled with your branding, and ready to ship the moment it's generated.

Install the MCP tool, tell Claude "Generate docs for my app", and get a complete, polished help center. No editing pass required. 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 user-facing documentation, and assembles a ready-to-ship help center — all through MCP tools. The output is end-user ready: your customers can start using it immediately.

What You Get

The output isn't a rough draft — it's a production help center your users can navigate on day one:

  • Getting Started guide that walks new users through setup and first actions
  • Feature guides with numbered, annotated screenshots showing exactly where to click
  • FAQ and Troubleshooting pages covering common questions and error states
  • Full-text search, responsive layout, and your brand colors baked in
  • Deployable immediately — no review cycle, no copy-editing, no formatting cleanup

How It Works (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 end-user articles — plain language, task-oriented, with screenshot references
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
discover_routes Static analysis of routes, services, and metadata
analyze_codebase Tree-sitter parsing for code chunks, error patterns, data models
capture_screenshots Headless browser capture with auth and PII blur
annotate_screenshots Numbered callouts on UI elements via Pillow
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
Themes Default theme 6 premium themes + custom brand colors, fonts, dark mode
Analytics No Search queries, article feedback, page views
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

kodadocs-2.0.0.tar.gz (176.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

kodadocs-2.0.0-py3-none-any.whl (68.1 kB view details)

Uploaded Python 3

File details

Details for the file kodadocs-2.0.0.tar.gz.

File metadata

  • Download URL: kodadocs-2.0.0.tar.gz
  • Upload date:
  • Size: 176.2 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

Hashes for kodadocs-2.0.0.tar.gz
Algorithm Hash digest
SHA256 85f705d43a0c5f0312a77f3a6d723a472adb5b46d56b7b4eaf1146813907b690
MD5 a9a27bcbda6193631a90d661b884c011
BLAKE2b-256 234eb5e59158fbe73cbe06e4cf7054a7547bed2abe20f409f10bf890201bc646

See more details on using hashes here.

File details

Details for the file kodadocs-2.0.0-py3-none-any.whl.

File metadata

  • Download URL: kodadocs-2.0.0-py3-none-any.whl
  • Upload date:
  • Size: 68.1 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

Hashes for kodadocs-2.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 a8b9e1001f9b2a01a3118eef7fa8dca99b833162f0abce1aaeb6593edc080896
MD5 eba1e5c6ca269cb784cc678d8d236b5d
BLAKE2b-256 453a50c01b0ad3a5aa783fde9867c7ea3989ef7f74c0fa2fa38c8df4dc10f59f

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page