mcpField
K
Kodadocs

Kodadocs

ローカル
github.com/Kodadocsメモリ・ナレッジ234 週間前に更新

Kodadocs について

Kodadocsは、WebアプリのコードとブラウザーのスクリーンショットからVitePressのヘルプセンターを生成する、オープンソースのClaude Code向けMCPツール兼コマンドラインツールです。ルートの検出、画面注釈、記事作成を一連のワークフローにまとめ、アプリのドキュメントを作成するチームを支援します。

主な機能

  1. 01Webフレームワークの検出とルート探索
  2. 02ヘッドレスブラウザーでのスクリーンショット取得
  3. 03PIIのぼかしとUI要素の注釈
  4. 04ドキュメント記事の生成
  5. 05VitePressサイトの構築とデプロイ

活用シーン

  1. 01アプリのコードベースからヘルプセンターを作成
  2. 02ログイン後のルートをドキュメント化
  3. 03機能ガイド用の注釈付き画像を用意

MCP 対応

MCPサーバーは、フレームワーク検出、ルートとコードの分析、スクリーンショットの取得と注釈、VitePressの構築、デプロイ用ツールを提供します。Claude Codeがこれらの手順を調整できます。

設定

ローカルサーバーの設定はどのクライアントでも共通です。コピーしてクライアントの MCP 設定ファイルに貼り付けてください。

mcp.json · 共通設定
{
"mcpServers": {
"kodadocs": {
"command": "uvx",
"args": [
"kodadocs"
]
}
}
}
起動コマンドuvx kodadocs

ローカルサーバーにはマシン上の実行環境(Node.js 18 以上など)が必要です。設定ファイルの場所はクライアントごとに異なります。

パッケージ
pypikodadocs

ツール

9

掲載時のツール一覧 · 2 週間前に更新

パラメーター型必須説明
project_pathstringはい

詳細

KodaDocs

PyPI version PyPI Downloads GitHub stars License: MIT Python 3.12+

kodadocs.com | ドキュメント | AI がウェブアプリ向けのヘルプドキュメントを数分で作成します。数週間もかかりません。

KodaDocs はオープンソースの Claude Code MCP ツールです。インストールして、Claude に「アプリのドキュメントを生成して」と伝えるだけで、注釈付きスクリーンショットと AI が作成した記事を備えた完全なヘルプセンターが完成します。無料でセルフホストできます。無制限のページ、12 個のスキルワークフロー、すべてのプレミアムテーマが使える Pro Kit($29)もあります。オプションのホスト型デプロイ($5/月)を利用すれば、yourapp.kodadocs.com に公開できます。

KodaDocs のデモ — 1 つのコマンドでドキュメントを生成

クイックスタート

Claude Code の設定(~/.claude/settings.json)に MCP サーバーを追加します。

{
  "mcpServers": {
    "kodadocs": {
      "command": "uvx",
      "args": ["kodadocs", "mcp"]
    }
  }
}

スクリーンショット撮影用のブラウザーをインストールします(初回のみ)。

uvx --with kodadocs playwright install chromium

次に、Claude に伝えます。

「アプリのヘルプドキュメントを生成して」

Claude はコードを読み取り、スクリーンショットを撮影し、ドキュメントを作成して、VitePress のヘルプセンターを構築します。すべて MCP ツールを通じて行われます。

CLI(任意)

CLI を直接使いたいパワーユーザー向けです。

pip install kodadocs
kodadocs generate .
kodadocs deploy .

ショーケース

KodaDocs が生成するドキュメントをご覧ください。以下のドキュメントは 2 分以内に作成されました。

プロジェクトフレームワーク公開ドキュメント
HonoHonohono.kodadocs.com
DrizzleDrizzle ORMdrizzle.kodadocs.com
Create T3 AppNext.jscreate-t3-app.kodadocs.com

あなたのプロジェクトもここに掲載しませんか?KodaDocs でドキュメントを生成して、お知らせください。

仕組み

Your web app ──► KodaDocs ──► Complete help center
                   │
                   ├── Detects framework (Next.js, Django, Flask, WordPress, ...)
                   ├── Discovers routes from source code
                   ├── Launches headless browser & authenticates
                   ├── Captures screenshots with PII blurring
                   ├── Draws numbered callouts on UI elements
                   ├── Claude writes all articles
                   └── Assembles VitePress site & deploys
フェーズ内容
検出フレームワークを検出し、コードからルートを特定します
撮影ヘッドレスブラウザーを起動し、認証してスクリーンショットを撮影します
注釈UI 要素に番号付きのコールアウトを描画します
ドキュメント作成Claude がすべての記事(入門ガイド、機能ガイド、FAQ、トラブルシューティング)を作成します
構築ブランディング、検索、モバイルレイアウトを備えた VitePress サイトを構築します
デプロイCloudflare、Vercel、Netlify、GitHub Pages、または kodadocs.com にデプロイします

対応フレームワーク

Next.js、Nuxt、React、Vue、Angular、SvelteKit、Remix、Astro、Django、Flask、FastAPI、Rails、Laravel、Express、Hono、WordPress、Chrome 拡張機能などに対応しています。

MCP ツール

ツール説明
detect_frameworkプロジェクトファイルからウェブフレームワークを自動検出します
discover_routesルート、サービス、メタデータを静的解析します
analyze_codebaseTree-sitter でコードチャンク、エラーパターン、データモデルを解析します
capture_screenshots認証と PII のぼかしに対応したヘッドレスブラウザーで撮影します
annotate_screenshotsPillow を使って UI 要素に番号付きのコールアウトを追加します
assemble_vitepress記事とスクリーンショットから完全な VitePress サイトを構築します
deploy_siteホスティングプロバイダーにデプロイします
save_manifest / load_manifestパイプラインの状態を保存・読み込みします

Claude Code スキル

KodaDocs には、パイプライン全体のオーケストレーション方法を Claude に教えるスキルファイルが含まれています。インストールするには、次のコマンドを実行します。

mkdir -p .claude/skills
cp kodadocs/skill/kodadocs.md .claude/skills/kodadocs.md

CLI

KodaDocs はスタンドアロンの CLI としても動作します(pip install kodadocs が必要です)。

kodadocs generate .                              # Run full pipeline
kodadocs generate . --url http://localhost:3000   # Override app URL
kodadocs generate . --user admin --pass secret    # Auth-gated apps
kodadocs deploy . --provider cloudflare           # Deploy to provider
kodadocs init .                                   # Interactive setup wizard
kodadocs config .                                 # View/update config
kodadocs mcp                                      # Start MCP server

ログインで保護されたアプリ

KodaDocs は、ログインが必要なアプリを自動的に処理します。

  1. kodadocs init または --user / --pass フラグを使って認証情報を指定します
  2. KodaDocs はヘッドレスブラウザーでログインし、セッションを保存します
  3. 認証後のクロールにより、未認証の訪問者には見えないルートが検出されます
  4. すべてのスクリーンショットは、認証済みのセッションで撮影されます

API キー

KodaDocs でドキュメントを生成するには、Anthropic API キーが必要です。

Claude Code(MCP)の場合: API キーは自動的に提供されるため、設定は不要です。

CLI の場合: 環境にキーを設定します。

export ANTHROPIC_API_KEY=sk-ant-...

料金

機能無料Pro Kit($29)+ ホスティング($5/月)
1 回の生成あたりのページ数15無制限無制限
フレームワークすべて(18 以上)すべて(18 以上)すべて(18 以上)
テーマデフォルトすべて(プレミアム 6 以上)すべて(プレミアム 6 以上)
カスタムブランディングなしありあり
ログインで保護されたアプリなしありあり
スキルファイル—プロ向けワークフロー 12 個プロ向けワークフロー 12 個
バッジ常に表示削除可能削除可能
セルフホストでのデプロイ可能可能可能
マネージドホスティング——yourapp.kodadocs.com
カスタムドメイン——help.yourapp.com
検索アナリティクス——あり

ユーザーは各自の Anthropic API キーを使用するため、生成が制限されることはありません。

Pro Kit を入手 — 無制限のページ数、プレミアムテーマ、プロ向けスキルワークフロー 12 個が利用できます。

貢献

開発環境のセットアップとガイドラインについては、CONTRIBUTING.md をご覧ください。

ライセンス

MIT

コメント

MCP は初めてですか?

プロトコルの概要から最初のサーバーの導入まで、よくある疑問にまとめて答えます。

AI アプリケーションが外部のツールやデータソースに統一的な方法で接続するためのオープンなプロトコルです。クライアントはモデルとの対話を担い、MCP サーバーはツール・リソース・プロンプトテンプレートを提供します。標準メッセージでやり取りするため、1 つのサーバーを複数のクライアントで再利用できます。