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. Pro Kit ($29 one-time) for unlimited pages, 12 skill workflows, and all premium themes.

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

Pricing

Feature Free Pro Kit ($29) + Hosting ($5/mo)
Pages per generation 15 Unlimited Unlimited
Frameworks All 18+ All 18+ All 18+
Themes Default All 6+ premium All 6+ premium
Custom branding No Yes Yes
Auth-gated apps No Yes Yes
Skill files 12 pro workflows 12 pro workflows
Badge Always shown Removable Removable
Self-host deploy Yes Yes Yes
Managed hosting yourapp.kodadocs.com
Custom domain help.yourapp.com
Search analytics Yes

Get the Pro Kit

Doc generation is never gated — free or Pro.

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.1.0.tar.gz (336.7 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.1.0-py3-none-any.whl (69.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: kodadocs-2.1.0.tar.gz
  • Upload date:
  • Size: 336.7 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.1.0.tar.gz
Algorithm Hash digest
SHA256 d0345ec0ea2ec9b51433d1a3f00a524109e89ca6a9203bc43efebb2806a5f6c5
MD5 871693267a381c55ca03cc1e2def6742
BLAKE2b-256 575dbe403e409440c3ce31a8c7ebfb8d4b2f6ded203a515709edbfa13a7233b9

See more details on using hashes here.

File details

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

File metadata

  • Download URL: kodadocs-2.1.0-py3-none-any.whl
  • Upload date:
  • Size: 69.7 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.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 552aeb787d286e430fb4728d883db79f8eadc54966418821166f6c710f0c0e7e
MD5 ebf4cd147e3b19764f6ac7e76b7cf9cf
BLAKE2b-256 e17287c8f5afc34b246628dacac49f70a8f89169dd2a91e4cfcc538acf5c4a61

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