Go Code Graph

🚀 Go Code Graph

Go Code Graphは、強力なGoコードベースアナライザーです。コードを探索可能なグラフに変換することで、AIアシスタントがModel Context Protocol (MCP) を通じて複雑なコードベースを理解できるようにします。

🚀 クイックスタート

MCPを使ったクイックスタート

1. Dockerを使ったセットアップ (推奨)

# クローンとセットアップ
git clone https://github.com/brutski/go-code-graph.git
cd go-code-graph
make dev-setup  # Neo4jを起動し、MCPサーバーイメージをビルドします

2. Claude Desktopの設定

make generate-mcp-config  # 必要な正確な設定を生成します

出力を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

3. AIでの使用開始

MCPサーバーが準備完了です！AIアシスタントが任意のGoコードベースを分析できます。

従来の使用方法 (MCPなし)

# ツールのビルド
make build

# コードベースの分析 (ローカルパッケージのみ)
./bin/analyze -repo=. -output=graph.json

# ブラウザで表示
./bin/server -graph=graph.json -port=8080
# http://localhost:8080/visualization を開く

✨ 主な機能

• 🔍 深いコード分析：Go ASTから9種類のノードタイプと12種類の関係タイプを抽出します。
• 🎨 インタラクティブな可視化：4,000以上のノードをリアルタイムでフィルタリングできるWebインターフェースを備えています。
• 🧠 AIによる理解：MCPサーバーにより、コードに関する自然言語クエリが可能です。
• 📊 グラフデータベース：複雑なアーキテクチャ分析のためにNeo4jと統合されています。
• 🚀 エンタープライズスケール：97パッケージと4,000以上のノードを持つコードベースで正常にテストされています。
• ⚡ セマンティック検索：コード理解を強化するためのオプションの埋め込み機能があります。

📦 インストール

MCPを使ったセットアップ

1. Dockerを使ったセットアップ (推奨)

# クローンとセットアップ
git clone https://github.com/brutski/go-code-graph.git
cd go-code-graph
make dev-setup  # Neo4jを起動し、MCPサーバーイメージをビルドします

2. Claude Desktopの設定

make generate-mcp-config  # 必要な正確な設定を生成します

出力を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

従来のセットアップ (MCPなし)

# ツールのビルド
make build

💻 使用例

基本的な使用法

# コードベースの分析 (ローカルパッケージのみ)
./bin/analyze -repo=. -output=graph.json

# ブラウザで表示
./bin/server -graph=graph.json -port=8080
# http://localhost:8080/visualization を開く

高度な使用法

MCPを使ったコードベースの分析

{
  "workspacePath": "/path/to/project",
  "workspaceName": "my-project",
  "incremental": false,
  "allowedPackages": [
    "github.com/gin-gonic/gin/...",
    "github.com/neo4j/neo4j-go-driver/v5"
  ]
}

📚 ドキュメント

詳細情報は、docsディレクトリを参照してください。

• Technical Architecture：システム設計、コンポーネント、および埋め込みに関する情報です。
• MCP Tools Reference：ツールの詳細なドキュメントと使用例があります。
• MCP Prompts Guide：ガイド付き分析のための包括的なプロンプトが記載されています。
• Tools vs Prompts：ツールとプロンプトの使い分けについて説明されています。
• Practical Usage Guide：一般的なワークフローとベストプラクティスが記載されています。
• Docker MCP Setup：Dockerを使ったMCPの詳細なデプロイメントガイドです。

🔧 技術詳細

MCPツールとプロンプト

MCPサーバーは、コードベースを分析する2つの方法を提供します。

MCPプロンプト (ガイド付きワークフロー)

MCPサーバーには、一般的な分析タスクをガイドする15の包括的なプロンプトが含まれています。これらのプロンプトは、AIアシスタントに使用するツールとその順序を正確に示し、ベストプラクティスと包括的なカバレッジを保証します。詳細なドキュメントは、MCP Prompts Guide を参照してください。

MCPツール (構成要素)

MCPサーバーは、直接コードベースを分析するための8つの強力なツールを提供します。これらはプロンプトが使用する構成要素ですが、特定のクエリやカスタム探索に直接使用することもできます。

外部依存関係の分析

デフォルトでは、アナライザーはモジュール内のパッケージのみを含めて、グラフを集中的かつ管理しやすく保ちます。ただし、外部依存関係を選択的に含めることで、コードがサードパーティのライブラリとどのように相互作用するかを理解できます。

テストと開発

テストスクリプト

scripts/ ディレクトリには、テストと開発に役立つユーティリティスクリプトが含まれています。

# 特定のツールのテスト
./scripts/test-mcp-tool.sh natural_query go-code-graph '{"question":"What are the most complex functions?"}'

# 包括的なテストスイートの実行
./scripts/test-mcp-tools.sh go-code-graph

# 新しいワークスペースのセットアップ
./scripts/setup-test-workspace.sh my-project /path/to/project

テストの実行

# すべてのテストを実行
make test

# カバレッジ付きで実行
make test-coverage

# 特定のパッケージのテストを実行
go test ./internal/analyzer -v

📄 ライセンス

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