支持的 AI 工具
Backlog.md 支持与多种主流 AI 编码助手集成。不同工具的连接方式略有差异,但核心原理一致:将 Backlog.md 的 MCP 服务器注册到 AI 客户端,使其能够直接调用 Backlog.md 的工具。
支持的工具一览
| 工具 | 集成方式 | 配置命令 |
|---|---|---|
| Claude Code | MCP | claude mcp add backlog --scope user -- backlog mcp start |
| OpenAI Codex | MCP | codex mcp add backlog -- backlog mcp start |
| Google Gemini CLI | MCP | gemini mcp add backlog -s user backlog mcp start |
| Kiro | MCP | kiro-cli mcp add --scope global --name backlog --command backlog --args mcp,start |
| Cursor | MCP | 手动配置 mcpServers |
| GitHub Copilot | CLI 指令 | 生成 copilot-instructions.md |
Claude Code
Claude Code 是 Anthropic 推出的命令行 AI 助手,原生支持 MCP。
执行以下命令完成注册:
claude mcp add backlog --scope user -- backlog mcp start
参数说明:
--scope user:将配置写入用户级配置,所有项目可用--后的backlog mcp start:启动 Backlog.md MCP 服务器的命令
注册成功后,在 Claude Code 会话中输入 @backlog 即可调用 Backlog.md 工具。
OpenAI Codex
OpenAI Codex CLI 同样支持 MCP 协议。
执行以下命令:
codex mcp add backlog -- backlog mcp start
注意 Codex 使用
--作为 stdio 命令分隔符。该格式已更新以匹配当前 Codex CLI 行为。
Codex 会自动将 Backlog.md 的工具集纳入可用工具列表。在对话中,Codex 会根据上下文自主决定何时调用 Backlog.md 工具。
Google Gemini CLI
Gemini CLI 通过 gemini 命令提供 MCP 支持。
执行以下命令:
gemini mcp add backlog -s user backlog mcp start
参数说明:
-s user:等同于--scope user,作用于用户范围backlog mcp start:启动命令
Kiro
Kiro CLI 的配置方式略有不同,需要显式指定参数拆分方式。
执行以下命令:
kiro-cli mcp add --scope global --name backlog --command backlog --args mcp,start
注意 --args 后的参数使用逗号分隔,而不是空格。
Cursor
Cursor 支持两种方式与 Backlog.md 集成。
方式一:MCP 配置
打开 Cursor 的设置,找到 MCP 配置入口,手动添加 mcpServers 配置:
{
"mcpServers": {
"backlog": {
"command": "backlog",
"args": ["mcp", "start"]
}
}
}
配置保存后,Cursor 的 AI 助手即可使用 Backlog.md 的全部工具能力。
方式二:CLI 指令文件(AGENTS.md)
Cursor 也会读取项目根目录的 AGENTS.md 作为通用代理指令。运行 backlog init 或 backlog agents --update-instructions 时,Cursor 对应的指令会写入 AGENTS.md,不再生成单独的 .cursorrules 文件。重复执行时,现有 AGENTS.md 内容会被保留,Backlog.md 只更新其中的标记区块。
GitHub Copilot
GitHub Copilot 目前不支持 MCP 协议,因此采用 CLI 指令方式集成。
运行以下命令生成代理指令文件:
backlog agents --update-instructions
该命令会在项目根目录生成 .github/copilot-instructions.md,其中包含:
- Backlog.md 的完整 CLI 命令参考
- 任务创建规范
- 验收标准格式
- 工作流指南
Copilot 在生成代码时会读取该文件,了解项目的任务管理规范,从而更好地协助开发。
验证集成是否成功
完成配置后,可以通过以下方式验证:
- 启动对应的 AI 客户端
- 输入类似 "列出我的待办任务" 的指令
- 观察 AI 是否正确调用了 Backlog.md 的
list_tasks工具 - 如果 AI 返回了当前项目的任务列表,说明集成成功
如果集成失败,请检查:
backlog命令是否在系统 PATH 中backlog mcp start是否能正常启动(可单独在终端测试)- AI 客户端的 MCP 配置是否正确指向了
backlog mcp start - 如果使用 Codex,确认命令包含
--分隔符 - 如果 AI 启动的是编译后的二进制而非源码,确保
dist/backlog已重新构建