前言

CodeGraph 是一个代码知识图谱工具,能让 AI 真正理解你的项目结构。本文将详细介绍在 Windows 环境下,为 Trae IDE 配置 CodeGraph 的完整过程。

适用场景:大型项目、复杂代码库、需要 AI 深度理解代码的业务场景(如拼团系统)


一、环境准备

1.1 系统要求

  • Windows 10/11
  • Trae IDE(已安装)
  • Node.js(推荐 18.x 或更高)

1.2 检查 Node.js

node -v

如果没有安装,去 Node.js 官网 下载 LTS 版本。


二、安装 CodeGraph

2.1 使用 npm 安装(推荐)

打开 PowerShell,执行:

npm install -g @colbymchenry/codegraph --registry=https://registry.npmmirror.com

为什么用淘宝镜像? 国内网络直接安装可能失败,淘宝镜像速度更快。

2.2 验证安装

codegraph --version

显示版本号(如 0.9.9)即表示安装成功。


三、建立项目索引

进入你的项目目录,初始化 CodeGraph:

cd F:\你的项目路径
codegraph init -i

这个过程会

  • 扫描所有代码文件
  • 分析类、函数、调用关系
  • 建立知识图谱数据库

耗时参考

  • 小型项目(< 500 文件):1-2 分钟
  • 中型项目(500-2000 文件):10-30 分钟
  • 大型项目(> 2000 文件):30-60 分钟

💡 首次索引会比较慢,之后增量更新就快了。建议在空闲时运行。


四、配置 Trae MCP

4.1 创建配置文件

C:\Users\你的用户名\.cursor\ 目录下创建 mcp.json 文件。

如果目录不存在,手动创建。

4.2 写入配置

{
  "mcpServers": {
    "codegraph": {
      "command": "codegraph",
      "args": ["serve", "--mcp", "--path", "F:\\你的项目路径"],
      "cwd": "F:\\你的项目路径"
    }
  }
}

关键点--path 参数必须指向你的项目根目录,否则 CodeGraph 找不到索引。

4.3 重启 Trae

完全退出 Trae(任务管理器结束进程),重新打开。


五、验证安装

5.1 检查 MCP 状态

在 Trae 中按 Ctrl+Shift+P,输入 “MCP”,查看 codegraph 是否显示 “Running”。

5.2 测试查询

在 Trae AI 对话框中输入:

{
  "kind": "class",
  "query": "你的业务关键词",
  "limit": 5
}

如果能返回结果,说明配置成功。


六、常见问题与解决方案

6.1 SSL/TLS 错误

错误信息请求被中止: 未能创建 SSL/TLS 安全通道

原因:GitHub raw 域名被限制

解决方案:使用 npm 安装(见 2.1),不要使用 irm 命令。

6.2 C 盘空间不足

现象:多次安装失败导致 C 盘变红

解决方案

# 清理 npm 缓存
npm cache clean --force

# 迁移缓存到 D 盘
npm config set cache "D:\nodejs-cache\npm-cache"

# 查看并清理不必要的全局包
npm list -g --depth=0
npm uninstall -g 包名

6.3 MCP 连接失败

错误信息No CodeGraph project is loaded for this session

原因:CodeGraph 启动时没有指定项目路径

解决方案:在 mcp.json 中添加 --path 参数(见 4.2)

6.4 索引一直跑不完

解决方案:排除不需要的目录

codegraph init -i --ignore "**/node_modules/**,**/dist/**,**/*.test.js"

七、使用技巧

7.1 创建专用 AI 智能体

在 Trae 中创建 “CodeGraph Analyzer” 智能体,系统提示词:

你是代码分析专家,通过 CodeGraph 分析代码。

当你遇到以下问题,必须使用 CodeGraph:
- "找出所有调用 X 函数的地方"
- "修改 X 会影响哪些代码?"
- "X 函数的完整调用链路是什么"
- "哪些核心函数没有被测试覆盖"

直接用自然语言回答,不需要展示调用细节。

项目路径:F:\你的项目路径

7.2 常用查询(自然语言)

你想知道 就这样问
找所有调用 X 的地方 “找出所有调用 refund 函数的地方”
分析影响范围 “修改 checkGroupBuyTeanOver 会影响哪些代码?”
理解业务流程 “画出从创建订单到退款的完整调用链”
找未测试代码 “哪些核心函数没有被测试覆盖?”
找特定类 “项目中所有 Service 类有哪些?”

7.3 更新索引

代码有重大变更时:

cd F:\你的项目路径
codegraph init -i

八、效果对比

场景 不用 CodeGraph 使用 CodeGraph
找调用者 手动搜索,可能遗漏 精确返回所有调用位置
理解流程 打开多个文件,手动梳理 自动生成调用链
影响分析 凭经验猜测 精确到每个依赖
Token 消耗 基准 降低约 57%
响应速度 慢(需要搜索) 快(直接查索引)

九、总结

安装 CodeGraph 核心就四步:

  1. npm install -g @colbymchenry/codegraph
  2. cd 项目目录 && codegraph init -i
  3. 配置 Trae 的 mcp.json
  4. 重启 Trae

配置成功后,你的 AI 就拥有了项目的"内部地图",可以精准回答关于代码结构、调用关系、影响范围的问题。


附录:完整配置文件模板(比固定值更灵活一点)

位置C:\Users\你的用户名\.cursor\mcp.json


{

  "mcpServers": {

    "codegraph": {

      "command": "codegraph",

      "args": ["serve", "--mcp", "--path", "${workspaceFolder}"],

      "cwd": "${workspaceFolder}"

    }

  }

}

希望这篇文章能帮助你顺利完成安装。如果有问题,欢迎交流讨论!

Logo

AtomGit AI 社区提供模型库、数据集、Agent、Token等资源

更多推荐