Documcp

🚀 DocuMCP - インテリジェントなドキュメントデプロイメントMCPサーバー

DocuMCPは、オープンソースプロジェクトのドキュメントデプロイメントを革新するインテリジェントなModel Context Protocol (MCP)サーバーです。深いリポジトリ分析、インテリジェントな静的サイトジェネレーターの推薦、そして自動化されたGitHub Pagesデプロイメントワークフローを提供します。

🚀 クイックスタート

DocuMCPをMCPクライアントで設定したら、自然言語で指示を与えるだけです。

# 一括でのワークフロー
"analyze my repository and deploy documentation to GitHub Pages"

# ステップバイステップ
"analyze my repository for documentation needs"
"recommend the best static site generator for my project"
"set up documentation structure and deploy to GitHub Pages"

DocuMCPは、リポジトリ分析、インテリジェントなSSG推薦、コンテンツ生成、追跡と検証付きの自動デプロイメント、ユーザー設定管理、デプロイメント分析、メモリ強化インサイトなど30以上のツールを提供します。詳細なツールリファレンスは完全なドキュメントを参照してください。

✨ 主な機能

コア機能

• 🔍 リポジトリ分析：プロジェクト構造、依存関係、ドキュメントニーズの深い多層分析
• 🎯 SSG推薦：データ駆動型のJekyll、Hugo、Docusaurus、MkDocs、またはEleventyの推薦
• 📚 Diataxisフレームワーク：実績のある原則に基づいた良い構造のドキュメントの自動作成
• 🚀 GitHub Pagesデプロイメント：SSG固有の最適化を伴う自動ワークフロー生成
• ✅ デプロイメント検証：成功したデプロイメントのための包括的なチェックとトラブルシューティング

インテリジェンスと学習（フェーズ2）

• 🧠 過去のインテリジェンス：過去のデプロイメントから学習して推薦を改善
• 👤 ユーザー設定：あなたの設定とパターンに基づくパーソナライズされた推薦
• 📊 デプロイメント分析：デプロイメントパターンと成功率に関する包括的な洞察
• 🎯 スマートスコアリング：類似プロジェクトの成功率に基づくインテリジェントなSSGスコアリング
• 📈 トレンド分析：デプロイメントトレンドを特定し、ヘルススコアを提供

ドキュメントメンテナンス（v0.5.2+）

• 📅 新鮮度追跡：設定可能なしきい値でドキュメントの古さを監視
• ✅ 新鮮度検証：新鮮度メタデータを自動的に初期化および更新
• 🗺️ サイトマップ管理：SEOのためにsitemap.xmlを生成、検証、管理
• 🔗 知識グラフ統合：インテリジェントな推薦のために新鮮度履歴を追跡

AI駆動の意味解析（v0.6.0+）

• 🤖 LLM統合：DeepSeek、OpenAI、Anthropic、またはOllamaとのオプションの統合
• 🔍 意味コード分析：AIを使用して構文を超えた動作の変更を検出
• 🧪 サンプル検証：コード実行をシミュレートしてドキュメントのサンプルを検証
• 🎯 インテリジェントフォールバック：LLMが利用できない場合にASTのみの分析に円滑に移行
• 🔒 プライバシー第一：AST分析で完全にオフラインで動作し、LLMは完全にオプション

📦 インストール

# リポジトリをクローン
git clone https://github.com/tosin2013/documcp.git
cd documcp

# 依存関係をインストール
npm install

# プロジェクトをビルド
npm run build

💻 使用例

基本的な使用法

# 一括でのワークフロー
"analyze my repository and deploy documentation to GitHub Pages"

# ステップバイステップ
"analyze my repository for documentation needs"
"recommend the best static site generator for my project"
"set up documentation structure and deploy to GitHub Pages"

高度な使用法

DocuMCPの30以上のツールを使って、様々なタスクを実行できます。例えば、以下のようなコマンドを使って特定のタスクを実行できます。

# リポジトリ分析
"analyze_repository"
# SSG推薦
"recommend_ssg"
# デプロイメント
"deploy_pages"

📚 ドキュメント

必要条件

• Node.js：20.0.0以上
• npm：最新の安定版

MCPクライアントの設定

DocuMCPは、様々なMCP対応クライアントと連携します。以下は設定方法です。

Claude Desktop

1. Claude Desktopの設定ファイルを見つける：
   • macOS：~/Library/Application Support/Claude/claude_desktop_config.json
   • Windows：%APPDATA%\Claude\claude_desktop_config.json
   • Linux：~/.config/claude/claude_desktop_config.json
2. documcpサーバーの設定を追加する：

   {
     "mcpServers": {
       "documcp": {
         "command": "npx",
         "args": ["documcp"]
       }
     }
   }
   

3. Claude Desktopを再起動して設定を読み込む。

VS Code with GitHub Copilot

1. VS Code用のMCP拡張機能をインストール
2. VS Codeのsettings.jsonで設定する：

   {
     "mcp.servers": {
       "documcp": {
         "command": "npx",
         "args": ["documcp"]
       }
     }
   }
   

Cursor Editor

1. Cursorの設定で設定する：

   {
     "mcpServers": {
       "documcp": {
         "command": "npx",
         "args": ["documcp"]
       }
     }
   }
   

Gemini Code Assist

1. Geminiのドキュメントを確認してMCPサーバーの設定を行う
2. 上記と同様の設定を追加する

トラブルシューティング

• npxがPATHに含まれていることを確認する
• グローバルインストールの場合は、完全なパスを使用する：

  {
    "command": "node",
    "args": ["/usr/local/lib/node_modules/documcp/dist/index.js"]
  }
  

• インストールパスを見つける：npm list -g documcp

主要ツール

分析と推薦

• analyze_repository - 深いリポジトリ構造と依存関係の分析
• recommend_ssg - 過去のデータとユーザー設定を考慮したインテリジェントなSSG推薦
• detect_gaps - 欠けているドキュメントセクションを特定

デプロイメントと追跡

• deploy_pages - 結果を追跡した自動GitHub Pagesデプロイメント
• verify_deployment - 包括的なデプロイメント検証
• analyze_deployments - デプロイメント履歴からの分析と洞察

ユーザー設定と学習

• manage_preferences - パーソナライズされた推薦のためのユーザー設定を管理
• 過去の成功率とデプロイメントパターンを表示
• 類似プロジェクトの成功に基づいた推薦を取得

開発

# 開発モードで実行
npm run dev

# テストを実行
npm test

# コードをリント
npm run lint

# 型チェック
npm run typecheck

アーキテクチャ

DocuMCPは、モジュール型のステートレスアーキテクチャに従います。

• TypeScriptベースの実装で、公式のMCP SDKを使用
• ステートレス動作で、一貫性と信頼性を確保
• モジュール設計で、関心事の明確な分離
• 段階的な複雑さで、ユーザーが簡単に始められる

ドキュメント構造（Diataxis）

DocuMCPは、Diataxisフレームワークに基づいてドキュメントを自動的に作成します。

• チュートリアル：初心者向けの学習ガイド
• ハウツーガイド：特定の目標を達成するためのタスク指向のレシピ
• リファレンス：情報指向の技術的な説明
• 解説：理解を深めるための概念的な議論

🔧 技術詳細

DocuMCPは、モジュール型のステートレスアーキテクチャを採用しています。TypeScriptで実装され、公式のMCP SDKを使用しています。ステートレス動作により、一貫性と信頼性が確保されています。また、モジュール設計により、関心事が明確に分離されており、ユーザーは簡単に始めることができます。

📄 ライセンス

このプロジェクトはMITライセンスの下で公開されています。詳細はLICENSEを参照してください。

コントリビューション

コントリビューションを歓迎します！詳細はコントリビューションガイドを参照してください。

初めてのコントリビューター

「good first issue」とラベル付けされた問題を探して、プロジェクトに参加してください。すべての経験レベルの開発者からのコントリビューションを歓迎します。

問題の報告

バグを報告するか機能を要求する場合は、問題テンプレートを使用してください。

行動規範

このプロジェクトはContributor Covenant行動規範に準拠しています。参加することで、この規範を守ることが期待されます。

セキュリティ

脆弱性やセキュリティ関連の問題を報告する場合は、セキュリティポリシーを参照してください。

謝辞

• Model Context Protocolに基づいて構築
• Diataxis Frameworkに従っています
• オープンソースプロジェクトのより良いドキュメントの必要性に触発されています