Codebase MCP Server

Codebase MCP Server

Codebase を安全かつ効率的に分析するための Model Context Protocol サーバー

主な機能 • 対応言語 • ツール • クイックスタート • ビルド • 貢献

🌟 主な機能

• 安全なアクセス：ファイル操作を事前に定義されたルートディレクトリ内に制限します。
• 効率的なファイル管理：ファイルの読み取りと検索に使えるツールを提供します。
• 詳細なメタデータ：サイズ、作成日時、最終更新日時、権限、種類など、包括的なファイルメタデータを取得します。
• 依存関係の分析：プロジェクト内の依存関係ツリーをたどって分析します。

📋 対応言語

• JavaScript/TypeScript
• CSS / CSS プリプロセッサ

🛠️ ツール

• get-project-basics：package.json の詳細やディレクトリ構造など、プロジェクトの基本情報を取得します。
• search-config-files：ルートディレクトリ内の設定ファイルを検索し、そのパスを返します。
• get-dependency-tree：指定されたファイルパスとルートディレクトリに基づいて依存関係ツリーをたどり、その結果を返します。
• list-directory：指定されたディレクトリの内容を一覧表示し、ファイルとディレクトリを区別します。
• read-file-with-metadata：指定されたファイルの内容を読み取り、そのメタデータを取得します。

🚀 クイックスタート

前提条件

• Node.js v18 以降
• LLM と通信する Codebase

インストール

まず、クライアントで Codebase MCP サーバーをインストールします。一般的な設定は次のとおりです。

{
  "mcpServers": {
    "Codebase": {
      "command": "npx",
      "args": ["codebase-mcp-server@latest", "/path/to/your/codebase"]
    }
  }
}

または、Docker を使って Codebase MCP サーバーをインストールすることもできます。

このリポジトリをクローンした後、Docker イメージをビルドします。

docker build -t mcp/codebase -f .

次に、以下を MCP サーバーのファイルに追加します。

{
  "mcpServers": {
    "Codebase": {
      "command": "docker",
      "args": [
        "run",
        "-i",
        "--rm",
        "--mount",
        "type=bind,src=/path/to/your/codebase/dir,dst=/projects/path/to/your/codebase/dir,ro",
        "--mount",
        "type=bind,src=/path/to/some/file.txt,dst=/projects/path/to/some/file.txt",
        "mcp/codebase",
        "/projects"
      ]
    }
  }
}

# For VS Code
code --add-mcp '{"name":"Codebase","command":"npx","args":["codebase-mcp-server@latest"]}'

{
  "mcpServers": {
    "Codebase": {
      "command": "npx",
      "args": ["codebase-mcp-server@latest"]
    }
  }
}

{
  "mcpServers": {
    "Codebase": {
      "command": "npx",
      "args": ["codebase-mcp-server@latest"]
    }
  }
}

{
  "mcpServers": {
    "Codebase": {
      "command": "npx",
      "args": ["codebase-mcp-server@latest"]
    }
  }
}

🔧 ビルド

ローカル開発ビルド

# Install dependencies
npm ci

# Build TypeScript
npm run build

Docker ビルド

# Build Docker image
docker build -t mcp/codebase -f .

# Or with specific tag
docker build -t mcp/codebase:latest -f .

🤝 貢献

皆さまからの貢献を歓迎します。行動規範とプルリクエストの提出手順については、貢献ガイドをお読みください。