综合介绍
codemcp 是一个开源工具,专为 Claude Desktop 用户设计,由 Edward Z. Yang 在 GitHub 上开发。它能让 Claude Desktop 成为一个实用的结对编程助手。用户可以直接通过对话让 Claude 在本地代码库中实现功能、修复 bug 或进行重构,操作过程无需手动复制粘贴代码。codemcp 支持 Anthropic 的 Claude Pro 订阅服务(每月 20 美元),避免了高额 API 费用。它通过限制工具集和强制使用 Git 版本控制,确保 AI 操作安全可控。开发者可以用自己喜欢的 IDE 检查和调整代码,适合各种编程场景。
功能列表
- 直接编辑本地代码:通过 Claude 修改项目文件,自动保存更改。
- 运行测试和格式化:执行测试脚本和格式化命令,保持代码质量。
- Git 提交管理:每次修改生成 Git 提交,支持查看和回滚。
- 项目配置支持:通过配置文件初始化项目,加载自定义指令。
- 日志跟踪:记录操作详情,便于排查问题。
使用帮助
安装流程
要使用 codemcp,需要先安装依赖并配置环境。以下是详细步骤:
- 安装 uv 工具
codemcp 依赖 uv 来运行。先安装 uv,推荐使用官方安装脚本:- Linux/MacOS:
curl -LsSf https://astral.sh/uv/install.sh | sh
- Windows(PowerShell):
powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"
安装后,运行
uv --version
检查版本,确保安装成功。 - Linux/MacOS:
- 配置 Claude Desktop
打开或创建claude_desktop_config.json
文件,添加以下内容:
{
"mcpServers": {
"codemcp": {
"command": "uvx",
"args": [
"--from",
"git+https://github.com/ezyang/codemcp@prod",
"codemcp"
]
}
}
}
保存后,Claude Desktop 会通过 uvx 从 GitHub 加载 codemcp。
- 设置项目配置文件
在你的 Git 仓库根目录下创建codemcp.toml
文件。例如:
format = ["./run_format.sh"]
test = ["./run_test.sh"]
format
:指定格式化脚本路径,用于代码规范化。test
:指定测试脚本路径,用于运行测试。
这些脚本需自行编写,确保能激活虚拟环境并正确运行。
如何使用
安装完成后,你可以在 Claude Desktop 中操作 codemcp。以下是具体流程:
1. 初始化项目
在 Claude Desktop 中新建一个 Project,在 Project Instructions 中输入:
Before doing anything, first init project $PROJECT_DIR.
将 $PROJECT_DIR
替换为你的项目路径,例如 /Users/username/myproject
。初始化后,codemcp 会读取 codemcp.toml
配置。
2. 通过对话修改代码
在 Claude Desktop 聊天窗口中,直接告诉 Claude 你想要的更改。例如:
- “在 main.py 中添加一个计算斐波那契数列的函数。”
- “修复 utils.py 中的逻辑错误。”
Claude 会通过 codemcp 编辑文件,每次更改后自动生成 Git 提交。可以用git log
查看提交历史。
3. 检查和管理代码更改
建议在独立分支(如 develop
)上运行 codemcp,默认分支设为 main
。以下是常用 Git 命令:
- 查看改动:
git diff main
显示与主分支的差异。 - 接受改动:
git fetch . develop:main
将更改合并到主分支。- 保留提交历史:先
git checkout main
,再git merge develop --no-ff
。 - 压缩提交:运行
git rebase -i
,选择 squash 后执行 fetch。
- 保留提交历史:先
- 撤销改动:
git reset --keep main
恢复到主分支状态。
4. 执行测试和格式化
如果配置了 test
和 format
,可以要求 Claude 运行这些命令。例如:
- “运行所有测试,检查代码是否正常。”
- “任务完成后格式化代码。”
测试会在任务中途运行,格式化则在任务结束时执行。
5. 处理限流
Claude Pro 有时间限制,遇到限流时 Claude 会暂停。你可以利用这段时间:
- 检查已生成的代码。
- 规划下一步任务。
限流解除后,继续对话即可。
6. 查看日志
如遇问题,可查看 ~/.codemcp/codemcp.log
日志文件。若需更详细记录,编辑 ~/.codemcprc
:
[logger]
verbosity = "DEBUG"
支持的级别有 DEBUG、INFO、WARNING、ERROR、CRITICAL。
特色功能操作
- 安全设计:codemcp 限制 Claude 的工具范围,避免误操作。所有更改通过 Git 可回滚。
- IDE 兼容:代码修改后,可用任意 IDE(如 VS Code)审查和调整。
- 手动控制:非自动代理,每次任务需用户检查并继续,确保代码方向正确。
通过这些步骤,你可以快速上手 codemcp,提升编程效率。