Codemcp

🚀 CKB — コード知識バックエンド

コードを理解し、安全に変更し、自信を持ってリリースしましょう。

CKBは、コードベースをクエリ可能な知識ベースに変換します。CLI、API、またはAIアシスタントを通じて、質問を投げかけ、影響を理解し、コードの所有者を見つけ、未使用コードを検出することができます。

あらゆるコード行、すべての決定、そしてすべてのコード所有者を知るシニアエンジニアのように、24時間体制で質問に答えてくれる存在だと考えてください。

🚀 クイックスタート

オプション1: npm (推奨)

# グローバルにインストール
npm install -g @tastehub/ckb

# または、インストールせずにnpxで直接実行
npx @tastehub/ckb init

オプション2: Homebrew (macOS/Linux)

brew tap SimplyLiz/ckb
brew install ckb

オプション3: ソースからビルド

git clone https://github.com/SimplyLiz/CodeMCP.git
cd CodeMCP
go build -o ckb ./cmd/ckb

セットアップ

# 1. プロジェクト内で初期化
cd /path/to/your/project
ckb init   # または: npx @tastehub/ckb init

# 2. SCIPインデックスを生成 (オプションだが推奨)
ckb index  # 言語を自動検出し、適切なインデクサを実行

# 3. Claude Codeに接続
ckb setup  # 自動的に.mcp.jsonを作成

# または手動で:
claude mcp add --transport stdio ckb -- npx @tastehub/ckb mcp

起動時に表示されるトークン効率:

CKB MCP Server v8.0.0
  Active tools: 14 / 76 (18%)
  Estimated context: ~1k tokens
  Preset: core

これでClaudeは以下のような質問に答えることができます:

• "HandleRequest関数を呼び出すものは何ですか？"
• "APIからProcessPaymentに到達する方法は？"
• "UserServiceを変更した場合の影響範囲はどれくらいですか？"
• "internal/apiモジュールの所有者は誰ですか？"
• "このレガシーコードはまだ使用されていますか？"

✨ 主な機能

難しい質問に即座に答える

できること

🔍 理解 — 意味検索、呼び出しグラフ、使用トレース、アーキテクチャマップ

⚡ 分析 — 影響分析、リスクスコアリング、ホットスポット検出、結合分析

🛡️ 保護 — 影響を受けるテストの検出、破壊的変更の警告、PRリスク評価

🔐 セキュリティ — シークレット検出、資格情報スキャン、セキュリティに敏感なコードの特定

👥 コラボレーション — オーナーシップの検索、レビュアーの提案、アーキテクチャ上の決定 (ADRs)

📊 改善 — 未使用コードの検出、技術的負債の追跡、ドキュメントのカバレッジ

🚀 複合操作 — 単一呼び出しツール (explore, understand, prepareChange) でAIツールの呼び出しを60-70%削減

🔗 統合 — CLI、HTTP API、AIツール用のMCP、CI/CDパイプライン、カスタムスクリプト

📦 インストール

オプション1: npm (推奨)

# グローバルにインストール
npm install -g @tastehub/ckb

# または、インストールせずにnpxで直接実行
npx @tastehub/ckb init

オプション2: Homebrew (macOS/Linux)

brew tap SimplyLiz/ckb
brew install ckb

オプション3: ソースからビルド

git clone https://github.com/SimplyLiz/CodeMCP.git
cd CodeMCP
go build -o ckb ./cmd/ckb

💻 使用例

すぐに試してみる

# コードベースのリスク箇所を確認
ckb hotspots --format=human

# 何が変更され、何が壊れる可能性があるかを確認
ckb diff-summary --format=human

# 公開されたシークレットをスキャン
ckb audit --format=human

# アーキテクチャを一覧で確認
ckb arch --format=human

# システムの状態を確認
ckb status

CLIの使用例

ckb status           # システムの健全性 (修復提案付き)
ckb search Handler   # シンボルを検索
ckb diff-summary     # 変更内容を分析
ckb hotspots         # リスクの高い領域
ckb arch             # アーキテクチャの概要
ckb ownership        # ファイル/パスのオーナーシップ
ckb mcp              # MCPサーバーを起動

v8.0複合操作 (MCP経由):

# これらのツールは複数のクエリを単一の呼び出しにまとめます
explore      # 領域の探索: シンボル、依存関係、ホットスポット
understand   # シンボルの詳細調査: 参照、呼び出し元、説明
prepareChange # 変更前の分析: 影響、テスト、リスク
batchGet     # 一度に最大50個のシンボルを取得
batchSearch  # 一度に最大10個の検索を実行

HTTP APIの使用例

# HTTPサーバーを起動
ckb serve --port 8080

# サンプルコール
curl http://localhost:8080/health
curl http://localhost:8080/status
curl "http://localhost:8080/search?q=NewServer"
curl http://localhost:8080/architecture
curl "http://localhost:8080/ownership?path=internal/api"
curl http://localhost:8080/hotspots

# インデックスサーバーモード (v7.3) - リモートクライアントにインデックスを提供
ckb serve --port 8080 --index-server --index-config config.toml

# インデックスサーバーのエンドポイント
curl http://localhost:8080/index/repos
curl http://localhost:8080/index/repos/company%2Fcore-lib/meta
curl "http://localhost:8080/index/repos/company%2Fcore-lib/symbols?limit=100"
curl "http://localhost:8080/index/repos/company%2Fcore-lib/search/symbols?q=Handler"

# アップロードエンドポイント (圧縮 + 認証付き)
curl -X POST http://localhost:8080/index/repos \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer ckb_xxx" \
  -d '{"id":"my-org/my-repo","name":"My Repo"}'

gzip -c index.scip | curl -X POST http://localhost:8080/index/repos/my-org%2Fmy-repo/upload \
  -H "Content-Encoding: gzip" \
  -H "Authorization: Bearer ckb_xxx" \
  --data-binary @-

# トークン管理 (インデックスサーバー管理者用)
ckb token create --name "ci-upload" --scope upload    # APIキーを作成
ckb token list                                         # すべてのトークンを一覧表示
ckb token revoke ckb_xxx                              # トークンを取り消す
ckb token rotate ckb_xxx                              # トークンをローテート (新しいシークレット、同じID)

MCP統合の使用例

Claude Code

# 現在のプロジェクト用に自動設定
npx @tastehub/ckb setup

# または、すべてのプロジェクトにグローバルに追加
npx @tastehub/ckb setup --global

または、.mcp.jsonに手動で追加:

{
  "mcpServers": {
    "ckb": {
      "command": "npx",
      "args": ["@tastehub/ckb", "mcp"]
    }
  }
}

Cursor

~/.cursor/mcp.json (グローバル) または .cursor/mcp.json (プロジェクト) に追加:

{
  "mcpServers": {
    "ckb": {
      "command": "npx",
      "args": ["@tastehub/ckb", "mcp"]
    }
  }
}

Windsurf

~/.codeium/windsurf/mcp_config.jsonに追加:

{
  "mcpServers": {
    "ckb": {
      "command": "npx",
      "args": ["@tastehub/ckb", "mcp"]
    }
  }
}

VS Code

VS Codeのsettings.jsonに追加:

{
  "mcp": {
    "servers": {
      "ckb": {
        "type": "stdio",
        "command": "npx",
        "args": ["@tastehub/ckb", "mcp"]
      }
    }
  }
}

OpenCode

プロジェクトルートのopencode.jsonに追加:

{
  "mcp": {
    "ckb": {
      "type": "local",
      "command": ["npx", "@tastehub/ckb", "mcp"],
      "enabled": true
    }
  }
}

Grok

# 現在のプロジェクト用に自動設定
npx @tastehub/ckb setup --tool=grok

# または、グローバルに追加
npx @tastehub/ckb setup --tool=grok --global

または、.grok/settings.json (プロジェクト) または ~/.grok/user-settings.json (グローバル) に手動で追加:

{
  "mcpServers": {
    "ckb": {
      "name": "ckb",
      "transport": "stdio",
      "command": "npx",
      "args": ["@tastehub/ckb", "mcp"]
    }
  }
}

Claude Desktop

Claude Desktopにはプロジェクトコンテキストがないため、リポジトリのパスを指定する必要があります。

自動セットアップ (推奨):

cd /path/to/your/repo
ckb setup --tool=claude-desktop

手動設定 — ~/Library/Application Support/Claude/claude_desktop_config.json (macOS) または %APPDATA%\Claude\claude_desktop_config.json (Windows) に追加:

{
  "mcpServers": {
    "ckb": {
      "command": "npx",
      "args": ["-y", "@tastehub/ckb", "mcp"],
      "env": {
        "CKB_REPO": "/path/to/your/repo"
      }
    }
  }
}

CKB_REPO環境変数は、CKBに分析するリポジトリを指定します。Claude Desktopは一度に1つのリポジトリのみで動作します。

Windows

上記のいずれかの設定でcmd /cラッパーを使用:

{
  "mcpServers": {
    "ckb": {
      "command": "cmd",
      "args": ["/c", "npx", "@tastehub/ckb", "mcp"]
    }
  }
}

プリセット (トークン最適化)

CKBは80以上のツールを公開していますが、ほとんどのセッションでは一部のツールのみが必要です。プリセットを使用すると、トークンのオーバーヘッドを最大83%削減できます:

# すべての利用可能なプリセットをツール数とトークン推定値とともに一覧表示
ckb mcp --list-presets

# デフォルト: コアプリセット (14の必須ツール)
ckb mcp

# ワークフロー固有のプリセット
ckb mcp --preset=core        # 14のツール - 検索、説明、影響 (デフォルト)
ckb mcp --preset=review      # 19のツール - コア + 差分、オーナーシップ
ckb mcp --preset=refactor    # 19のツール - コア + 結合、未使用コード
ckb mcp --preset=federation  # 28のツール - コア + クロスリポジトリ
ckb mcp --preset=docs        # 20のツール - コア + ドキュメントシンボルリンク
ckb mcp --preset=ops         # 25のツール - コア + ジョブ、ウェブフック、メトリクス
ckb mcp --preset=full        # 80以上のツール - すべてのツール (レガシー)

MCP設定で:

{
  "mcpServers": {
    "ckb": {
      "command": "npx",
      "args": ["@tastehub/ckb", "mcp", "--preset=review"]
    }
  }
}

AIは、セッション中にexpandToolsetツールを使用してツールセットを動的に拡張できます。

📚 詳細ドキュメント

どこでも動作する

スマートなプリセットでトークンを83%削減 — 必要なツールのみを読み込みます。

# Claude Codeに接続するための1つのコマンド
ckb setup

独自のツールを構築していますか？ CLI、HTTP API、またはMCPを介してCKBをバックエンドとして使用します。Node.js、Python、Go、およびシェルスクリプトの例については、統合ガイド を参照してください。

もっと学ぶ

インデックスの仕組み

CKBはSCIPインデックスを使用してコードを理解します。これは、すべての関数がどこで定義されているか、誰がそれを呼び出しているか、そしてすべてがどのように接続されているかを知るデータベースのようなものです。

基本

# 1. インデックスを生成 (言語を自動検出)
ckb index

# 2. インデックスが最新かどうかを確認
ckb status

インデックスがない場合でも、CKBはtree-sitterパースを使用して動作します (基本モード) が、インデックスがあると以下の機能が利用できます:

• ファイル間の参照 ("この関数を誰が呼び出していますか？")
• 正確な影響分析
• 呼び出しグラフのナビゲーション

言語サポート

すべての言語が同等ではありません。CKBは、インデクサの成熟度に基づいて言語を品質階層に分類します:

主な制限事項:

• 増分インデックス作成はGoのみでサポートされています。他の言語では完全な再インデックス作成が必要です。
• TypeScriptモノレポでは--infer-tsconfigフラグが必要な場合があります。
• **C/C++**ではcompile_commands.jsonが必要です。
• Pythonはアクティブ化された仮想環境で最適に動作します。

ckb doctor --tier standardを実行して、言語ツールが正しくインストールされているかを確認してください。

インデクサのインストール、既知の問題、および完全な機能マトリックスについては、言語サポート を参照してください。

インデックスを最新に保つ

コミットを行うと、インデックスが古くなります。CKBは、最新状態を維持するためのいくつかの方法を提供します:

AIセッションのクイックスタート:

ckb mcp --watch  # 古くなったときに30秒ごとに自動的に再インデックス化

古さを確認:

ckb status
# 表示: "HEADから5コミット遅れています" または "最新です"

Goプロジェクトでは、CKBは増分インデックス作成を使用します — 変更されたファイルのみが処理されるため、更新が高速です。

完全なドキュメントについては、インデックス管理ガイド を参照してください。

機能一覧

📖 完全な機能ガイド — サンプル付きの詳細なドキュメント

📋 変更履歴 — バージョンの履歴

なぜCKBを使うべきか？

3つの使用方法

内部の仕組み

CKBは複数のコードインテリジェンスバックエンドを調整します:

• SCIP — 正確な、事前にインデックス化されたシンボルデータ (最速)
• LSP — リアルタイムの言語サーバークエリ
• Git — blame、履歴、チャーン分析、オーナーシップ

結果は賢く統合され、LLMのコンテキスト制限に合わせて圧縮されます。

永続的な知識はセッションをまたいで保持されます:

• モジュールレジストリ — 境界、責任、タグ
• オーナーシップレジストリ — CODEOWNERS + 時間の経過によるgit-blame
• ホットスポットトラッカー — トレンド分析付きの履歴スナップショット
• 決定ログ — 全文検索付きのADRs

誰がCKBを使うべきか？

• AIアシスタントを使用する開発者 — AIツールに強力な機能を付与します
• 大規模なコードベースを持つチーム — 複雑さを効率的に管理します
• リファクタリングを行う人 — 変更前に影響を理解します
• コードレビュアー — 変更の全体像を把握します
• 技術リード — アーキテクチャの健全性を経時的に追跡します

制限事項 (正直な評価)

CKBの得意なこと:

• 静的コードのナビゲーション — 定義、参照、呼び出しグラフの検索
• 安全なリファクタリングのための影響分析
• オーナーシップの検索 (CODEOWNERS + git blame)
• アーキテクチャとモジュールの理解

CKBが役に立たないこと:

• 動的ディスパッチ / ランタイム動作 (デバッガーを使用してください)
• インデックス化されていない生成コード
• コード生成、リンティング、またはフォーマット
• クロスリポジトリ呼び出し (連合 を使用してください)

CKBは静的分析ツールであり、魔法ではありません。重要な決定は常に実際のコードを読んで検証してください。

📖 実用的な制限事項 — 精度、盲点、および結果を信頼するタイミングに関する完全なガイド

ドキュメント

以下の内容については、完全なドキュメントウィキ を参照してください:

• クイックスタート — ステップバイステップのインストール手順
• プロンプトクックブック — 実際の問題に対する実際のプロンプト
• 言語サポート — SCIPインデクサとサポート階層
• 実用的な制限事項 — 精度に関する注意事項、盲点
• ユーザーガイド — CLIコマンドとベストプラクティス
• インデックス管理 — インデックスの仕組み、自動更新方法
• 増分インデックス作成 — Goプロジェクトの高速インデックス更新
• ドキュメントシンボルリンク — ドキュメント内のシンボル検出、古さのチェック
• 認証 — APIトークン、スコープ、レート制限
• MCP統合 — Claude Codeのセットアップ、80以上のツール
• APIリファレンス — HTTP APIのドキュメント
• デーモンモード — スケジューラー、ウェブフック付きの常時オンサービス
• 設定 — MODULES.tomlを含むすべてのオプション
• アーキテクチャ — システム設計とコンポーネント
• セキュリティ — シークレットの検出、資格情報のスキャン
• テレメトリー — ランタイムの可観測性、未使用コードの検出
• 連合 — クロスリポジトリクエリ
• CI/CD統合 — GitHub Actions、PR分析

必要条件

npmを使用する場合 (推奨):

• Node.js 16以上
• Git

ソースからビルドする場合:

• Go 1.21以上
• Git

(高度な分析のための) オプション:

• あなたの言語用のSCIPインデクサ (scip-go, scip-typescriptなど) — ckb indexを実行して自動インストール

📄 ライセンス

無料で利用できる対象:

• 個人利用
• オープンソースプロジェクト
• 年間収益が25,000ドル未満のスタートアップや小規模企業

年間収益が25,000ドル以上の組織には商用ライセンスが必要です。チームおよびエンタープライズプランの価格については、価格表 を参照してください。または、完全な利用条件については、ライセンス を参照してください。