Kodadocs
@Kodadocs
关于 Kodadocs
AI-generated help docs for your web app in minutes, not weeks. KodaDocs is a Claude Code MCP server that reads your codebase, captures screenshots with a headless browser, annotates UI elements, writes documentation articles, and assembles a complete VitePress help center. Suppor
基本信息
配置
使用下面的配置,将此服务器添加到你的 MCP 客户端。
{
"mcpServers": {
"kodadocs": {
"command": "uvx",
"args": [
"kodadocs",
"mcp"
]
}
}
}工具
9Detect the web framework of a project at the given path. Returns the framework name (e.g., 'Next.js', 'Django', 'React'). Uses heuristic detection from package.json, requirements.txt, etc.
Capture screenshots for discovered routes using Playwright. Launches headless Chromium, authenticates if auth is provided, navigates to each route, captures screenshots, and extracts DOM elements. Returns JSON with screenshots dict and dom_elements dict.
Annotate screenshots with numbered callouts using Pillow. Takes screenshot directory and dom_elements dict (route -> element list). Each element needs: role, name, bounds {x, y, width, height}. Creates annotated copies in screenshots_dir/annotated/. Returns JSON with route -> annotated image path.
Assemble a VitePress static site from generated articles and screenshots. Creates index page, article markdown files, VitePress config, theme with brand color, and package.json. Pass theme_name to use a built-in theme preset (default, professional, minimal, playful, dark-modern, docs-classic). Pro themes require a valid license_key.
Save pipeline state to .kodadocs/run_manifest.json.
Load existing pipeline state from .kodadocs/run_manifest.json.
Deploy the generated VitePress site to a hosting provider. Supported providers: cloudflare, vercel, netlify, github-pages, kodadocs. For kodadocs provider: deploys to <site_slug>.kodadocs.com. Requires license_key (or KODADOCS_LICENSE_KEY env var) and site_slug. Pass license_key for other providers to remove the KodaDocs badge.
Discover application routes, services, and metadata via static analysis. Returns JSON with discovered_routes, route_metadata, detected_services, ui_components, and deployment_platform. Supports Next.js, SvelteKit, Nuxt, React Router, and WordPress. Pass app_url to enable Playwright crawler fallback when static analysis finds few routes.
Analyze codebase structure using tree-sitter parsing. Extracts code chunks (functions, classes), error patterns, and data models (Prisma, Drizzle). No AI calls — fully deterministic. Returns JSON with code_chunks, error_patterns, data_models, and file counts.
概览
What is Kodadocs?
Kodadocs is an open-source MCP server for Claude Code that automatically generates a complete help center for any web application. It produces polished documentation with AI-written articles and annotated screenshots.
How to use Kodadocs?
Install the package and Chromium browser, then ask Claude in Claude Code: “Generate help docs for my app.” The server handles the entire pipeline from discovery to deployment.
Key features of Kodadocs
- Auto-detects web framework from project files
- Discovers routes via static analysis
- Analyzes code for patterns and error handling
- Captures headless screenshots with auth and PII blur
- Annotates UI elements with numbered callouts
- Deploys to Cloudflare, Vercel, Netlify, or GitHub Pages
Use cases of Kodadocs
- Quickly generate a help center for a new web app
- Keep documentation in sync with a codebase as it evolves
- Automate screenshot capture and annotation for user guides
- Deploy a searchable VitePress documentation site to a hosting provider
FAQ from Kodadocs
What exactly does Kodadocs generate?
It creates a full VitePress help site with articles like Getting Started, Feature Guides, FAQ, and Troubleshooting, all written by AI and accompanied by annotated screenshots.
How do I install Kodadocs?
Run pip install kodadocs and then playwright install chromium. No other dependencies are needed.
Which frameworks are supported?
Next.js, Nuxt, React, Vue, Angular, SvelteKit, Remix, Astro, Django, Flask, FastAPI, Rails, Laravel, Express, Hono, WordPress, and more.
Can Kodadocs handle authenticated pages?
Yes—the headless browser capture tool includes support for authentication and also blurs personally identifiable information (PII).
Is Kodadocs open-source and free to use?
Yes, it is open-source. The MCP server itself is free; you only pay for Claude Code usage when generating docs.
记忆与知识 分类下的更多 MCP 服务器
MCP server for Obsidian
MarkusPfundsteinMCP server that interacts with Obsidian via the Obsidian rest API community plugin
Context7 MCP - Up-to-date Docs For Any Cursor Prompt
upstashContext7 Platform -- Up-to-date code documentation for LLMs and AI code editors
Anytype MCP Server
anyprotoAn MCP server enabling AI assistants to interact with Anytype - your encrypted, local and collaborative wiki - to organize objects, lists, and more through natural language.
Rust Docs MCP Server
Govcraft🦀 Prevents outdated Rust code suggestions from AI assistants. This MCP server fetches current crate docs, uses embeddings/LLMs, and provides accurate context via a tool call.
Memory Bank MCP Server
alioshrA Model Context Protocol (MCP) server implementation for remote memory bank management, inspired by Cline Memory Bank.
评论