Docs MCP

🚀 Docs MCP Server

このプロジェクトは、Probe をベースにした柔軟なモデルコンテキストプロトコル (MCP) サーバーを提供します。このサーバーは、ドキュメントやコードベースをAIアシスタントで検索可能にするように設計されています。

コードやドキュメントと会話することができます。単にGitリポジトリまたはフォルダを指定するだけです。

npx -y @buger/docs-mcp@latest --gitUrl https://github.com/buger/probe

🚀 クイックスタート

コードやドキュメントと会話するには、次のコマンドを実行します。

npx -y @buger/docs-mcp@latest --gitUrl https://github.com/buger/probe

✨ 主な機能

• Probeによる強力な検索エンジン：Probe 検索エンジンを活用し、効率的かつ関連性の高い検索結果を提供します。
• 柔軟なコンテンツソース：特定のローカルディレクトリを指定するか、Gitリポジトリをクローンすることができます。
• コンテンツの事前ビルド：オプションで、ドキュメントやコードコンテンツをパッケージに直接バンドルすることができます。
• 動的な設定：設定ファイル、CLI引数、または環境変数を介して、コンテンツソース、Git設定、およびMCPツールの詳細を構成できます。
• 自動Git更新：設定可能な間隔でGitリポジトリから変更を自動的に取得し、コンテンツを最新の状態に保ちます。
• カスタマイズ可能なMCPツール：AIアシスタントに公開される検索ツールの名前と説明を定義できます。
• AIとの統合：モデルコンテキストプロトコル (MCP) をサポートするAIアシスタントとシームレスに統合されます。

📦 インストール

Smitheryを介したインストール

Claude Desktop用にDocs MCP Serverを自動的にインストールするには、次のコマンドを実行します。

npx -y @smithery/cli install @buger/docs-mcp --client claude

💻 使用例

基本的な使用法

# コード例を使用して、特定のGitリポジトリを指定する
npx -y @buger/docs-mcp@latest --gitUrl https://github.com/buger/probe

高度な使用法

# 特定のGitHubリポジトリと会話する
{
  "mcpServers": {
    "tyk-docs-search": {
      "command": "npx",
      "args": [
        "-y",
        "@buger/docs-mcp@latest",
        "--gitUrl",
        "https://github.com/TykTechnologies/tyk-docs",
        "--toolName",
        "search_tyk_docs",
        "--toolDescription",
        "Search Tyk API Management Documentation"
      ],
      "enabled": true
    }
  }
}

📚 ドキュメント

設定

ルートディレクトリに docs-mcp.config.json ファイルを作成して、デフォルトのコンテンツソースとMCPツールの詳細を定義します（CLI引数または環境変数によって上書きされない限り）。

例1: ローカルディレクトリの使用

{
  "includeDir": "/Users/username/projects/my-project/docs",
  "toolName": "search_my_project_docs",
  "toolDescription": "Search the documentation for My Project.",
  "ignorePatterns": [
    "node_modules",
    ".git",
    "build",
    "*.log"
  ]
}

例2: Gitリポジトリの使用

{
  "gitUrl": "https://github.com/your-org/your-codebase.git",
  "gitRef": "develop",
  "autoUpdateInterval": 15,
  "toolName": "search_codebase",
  "toolDescription": "Search the main company codebase.",
  "ignorePatterns": [
    "*.test.js",
    "dist/",
    "__snapshots__"
  ]
}

設定オプション

独自の事前ビルドMCPサーバーの作成

このプロジェクトをテンプレートとして使用して、ドキュメントまたはコードが事前にビルドされた独自のnpmパッケージを作成および公開することができます。これにより、ユーザーにゼロコンフィギュレーションのエクスペリエンスを提供します。

1. このリポジトリをフォーク/クローンする：このプロジェクトのコードから始めます。
2. docs-mcp.config.json を設定する：コンテンツソースを指す includeDir または gitUrl を定義します。デフォルトの toolName と toolDescription を設定します。
3. package.json を更新する：name（例: @my-org/my-docs-mcp）、version、description などを変更します。
4. ビルドする：npm run build を実行します。これにより、コンテンツが data ディレクトリにクローン/コピーされ、パッケージが準備されます。
5. 公開する：npm publish を実行します（npm認証を設定する必要があります）。

これで、ユーザーは次のコマンドで特定のドキュメントサーバーを簡単に実行できます。

npx @my-org/my-docs-mcp@latest

📄 ライセンス

MIT