基本能力
产品定位
CircleCI MCP Server 是一个用于在开发环境中通过自然语言与 CircleCI 交互的工具,旨在提高开发效率和调试体验。
核心功能
- 自然语言交互:通过 MCP 协议,用户可以使用自然语言命令与 CircleCI 交互。
- 日志检索:支持从 CircleCI 构建中获取详细的失败日志。
- 本地项目上下文支持:可以从本地工作区提供上下文信息,如工作区根路径、Git 远程 URL 和分支名称。
适用场景
- 调试失败构建:快速获取失败构建的日志,帮助开发者定位问题。
- 分析测试失败:通过详细的日志信息分析测试失败原因。
- 部署问题调查:检查部署过程中的错误日志。
- IDE 集成:无需离开 IDE 即可访问构建日志。
工具列表
get_build_failure_logs
:从 CircleCI 构建中检索详细的失败日志。- 支持通过 CircleCI URL 或本地项目上下文获取日志。
- 返回格式化的日志,包括作业名称、步骤执行详情和失败消息。
常见问题解答
- 如何获取 CircleCI API 令牌?
- 可以通过 CircleCI 设置页面生成令牌,了解更多。
- 如何配置 Cursor IDE 使用该服务?
- 参考 Cursor MCP 配置指南。
使用教程
使用依赖
- pnpm 包管理器:
bash
npm install -g pnpm - Node.js ≥ v18.0.0:
bash
nvm install 18 - CircleCI API 令牌:
- 从 CircleCI 令牌设置页面 生成令牌。
安装教程
- Cursor IDE 配置:
- 在 Cursor 的 MCP 配置中添加以下内容:
json
{
"mcpServers": {
"circleci-mcp-server": {
"command": "npx",
"args": ["-y", "@circleci/mcp-server-circleci"],
"env": {
"CIRCLECI_TOKEN": "your-circleci-token"
}
}
}
}
调试方式
- 开发模式:
bash
pnpm watch - MCP 检查器:
bash
pnpm inspector - 测试:
bash
pnpm test
bash
pnpm test:watch