CircleCI MCP 服务器

模型上下文协议 (MCP) 是一种新的标准化协议，用于管理大型语言模型 (LLM) 和外部系统之间的上下文。 在此存储库中，我们为 CircleCI 提供了一个 MCP 服务器。

这使您可以使用 Cursor IDE 或任何 MCP 客户端，通过自然语言来完成 CircleCI 的相关操作，例如：

• 查找我的分支上最新的失败流水线并获取日志 https://github.com/CircleCI-Public/mcp-server-circleci/wiki#circleci-mcp-server-with-cursor-ide

https://github.com/user-attachments/assets/3c765985-8827-442a-a8dc-5069e01edb74

要求

• pnpm 包管理器 - 了解更多
• Node.js >= v18.0.0
• CircleCI API 令牌 - 您可以通过 CircleCI 生成一个。 了解更多 或点击此处快速访问。

安装

Cursor

将以下内容添加到您的 cursor MCP 配置中：

{
  "mcpServers": {
    "circleci-mcp-server": {
      "command": "npx",
      "args": ["-y", "@circleci/mcp-server-circleci"],
      "env": {
        "CIRCLECI_TOKEN": "your-circleci-token",
        "CIRCLECI_BASE_URL": "https://circleci.com"
      }
    }
  }
}

有关将 MCP 服务器与 cursor 结合使用的更多信息，请参见以下指南：https://docs.cursor.com/context/model-context-protocol#configuring-mcp-servers

功能

支持的工具

• get_build_failure_logs

  从 CircleCI 构建中检索详细的失败日志。 此工具可以通过两种方式使用：

  1. 使用 CircleCI URL：

     • 直接提供失败的作业 URL 或流水线 URL
     • 示例：“Get logs from https://app.circleci.com/pipelines/github/org/repo/123”

  2. 使用本地项目上下文：

     • 通过提供以下信息从您的本地工作区工作：
       • 工作区根路径
       • Git 远程 URL
       • 分支名称
     • 示例：“Find the latest failed pipeline on my current branch”

  该工具返回格式化的日志，包括：

  • 作业名称
  • 逐步执行的详细信息
  • 失败消息和上下文

  这对于以下情况特别有用：

  • 调试失败的构建
  • 分析测试失败
  • 调查部署问题
  • 无需离开 IDE 即可快速访问构建日志

开发

开始使用

1. 克隆存储库：

   git clone https://github.com/CircleCI-Public/mcp-server-circleci.git
   cd mcp-server-circleci
   

2. 安装依赖项：

   pnpm install
   

3. 构建项目：

   pnpm build
   

使用 MCP Inspector 进行开发

迭代 MCP 服务器的最简单方法是使用 MCP inspector。 您可以在 https://modelcontextprotocol.io/docs/tools/inspector 了解有关 MCP inspector 的更多信息

1. 启动开发服务器：

   pnpm watch # 使其在一个终端中保持运行
   

2. 在单独的终端中，启动 inspector：

   pnpm inspector
   

3. 配置环境：

   • 将您的 CIRCLECI_TOKEN 添加到 inspector UI 中的“环境变量”部分
   • 该令牌需要对您的 CircleCI 项目具有读取权限
   • （可选）您可以设置您的 CircleCI 基本 URL。 默认为 https//circleci.com

测试

• 运行测试套件：

  pnpm test
  

• 在开发期间以监视模式运行测试：

  pnpm test:watch
  

有关更详细的贡献指南，请参见 CONTRIBUTING.md