Codemcp

🚀 CKB — 代码知识后端

了解你的代码，安全地进行更改，自信地发布。

CKB 将你的代码库转换为可查询的知识库。通过命令行界面（CLI）、应用程序编程接口（API）或人工智能助手，你可以提出问题、了解变更影响、查找代码所有者以及检测死代码。

你可以将其视为一位资深工程师，他知晓代码的每一行、每一个决策和每一位代码所有者，并且随时为你答疑解惑。

🚀 快速开始

选项 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
  活跃工具：14 / 76 (18%)
  估计上下文：~1k 令牌
  预设：核心

现在，Claude 可以回答如下问题：

• “哪些地方调用了 HandleRequest 函数？”
• “从 API 如何调用到 ProcessPayment？”
• “如果我更改 UserService，影响范围有多大？”
• “internal/api 模块的所有者是谁？”
• “这段遗留代码是否仍在使用？”

✨ 主要特性

即时解答难题

功能概述

• 🔍 理解：语义搜索、调用图、使用追踪、架构图
• ⚡ 分析：影响分析、风险评分、热点检测、耦合分析
• 🛡️ 保护：受影响测试检测、重大变更警告、PR 风险评估
• 🔐 安全：机密检测、凭证扫描、安全敏感代码识别
• 👥 协作：所有权查找、审核人建议、架构决策（ADRs）
• 📊 改进：死代码检测、技术债务跟踪、文档覆盖率
• 🚀 复合操作：单调用工具（explore、understand、prepareChange）可将人工智能工具调用减少 60 - 70%
• 🔗 集成：命令行界面（CLI）、HTTP API、适用于人工智能工具的 MCP、CI/CD 管道、自定义脚本

📦 安装指南

推荐使用 npm 安装

# 全局安装
npm install -g @tastehub/ckb

# 或者直接使用 npx 运行（无需安装）
npx @tastehub/ckb init

使用 Homebrew 安装（macOS/Linux）

brew tap SimplyLiz/ckb
brew install ckb

从源代码构建

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

高级用法

# 一键连接到 Claude Code
ckb setup

📚 详细文档

进一步了解

三种使用方式

索引工作原理

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 提供了几种保持索引最新的方法：

人工智能会话快速启动：

ckb mcp --watch  # 索引过时后每 30 秒自动重新索引

检查索引是否过时：

ckb status
# 显示：“落后 HEAD 5 次提交” 或 “最新状态”

对于 Go 项目，CKB 使用 增量索引，只处理更改的文件，使更新速度更快。

完整文档请查看 索引管理指南。

功能特性

📖 完整功能指南 — 详细文档及示例

📋 更新日志 — 版本历史

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 个搜索

📖 用户指南 — 所有 CLI 命令和选项

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 集成

CKB 可与任何支持 MCP 的人工智能编码工具配合使用。

# 为当前项目自动配置
npx @tastehub/ckb setup

# 或者为所有项目全局添加
npx @tastehub/ckb setup --global

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

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

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

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

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

# 为当前项目自动配置
npx @tastehub/ckb setup --tool=grok

# 或者全局添加
npx @tastehub/ckb setup --tool=grok --global

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

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

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

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

# 列出所有可用预设，包括工具数量和令牌估计
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 多个工具 - 所有工具（旧版）

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

🔧 技术细节

底层原理

CKB 协调多个代码智能后端：

• SCIP：精确的预索引符号数据（最快）
• LSP：实时语言服务器查询
• Git：blame、历史记录、变更分析、所有权

结果会智能合并并压缩，以适应大语言模型（LLM）的上下文限制。

持久知识在会话之间保持有效：

• 模块注册表：边界、职责、标签
• 所有权注册表：CODEOWNERS + git blame，并考虑时间衰减
• 热点跟踪器：带有趋势分析的历史快照
• 决策日志：支持全文搜索的架构决策记录（ADRs）

适用人群

• 使用人工智能助手的开发者：为你的人工智能工具赋予强大能力
• 拥有大型代码库的团队：高效应对代码复杂性
• 进行代码重构的人员：在更改代码前了解影响
• 代码审核人员：全面了解代码变更
• 技术负责人：长期跟踪架构健康状况

局限性（客观说明）

CKB 的优势在于：

• 静态代码导航：查找定义、引用、调用图
• 安全重构的影响分析
• 所有权查找（CODEOWNERS + git blame）
• 架构和模块理解

CKB 无法提供帮助的方面：

• 动态调度/运行时行为（使用调试器）
• 未索引的生成代码
• 代码生成、代码检查或格式化
• 跨仓库调用（使用 联合 功能）

CKB 是静态分析工具，并非万能。在做出关键决策时，请始终阅读实际代码进行验证。

📖 实际限制 — 关于准确性、盲点以及何时信任结果的完整指南

📄 许可证

• 免费使用场景：个人使用、开源项目、年收入低于 25,000 美元的初创公司和小企业。
• 商业许可证要求：年收入超过 25,000 美元的组织需要商业许可证。请查看 定价 获取团队和企业计划，或查看 LICENSE 获取完整条款。