🚀 圈子CI MCP服务器

圈子CI MCP服务器基于模型上下文协议（MCP），这是管理大型语言模型（LLMs）与外部系统间上下文的新标准协议。借助该服务器，你能使用Cursor IDE或其他MCP客户端，通过自然语言与CircleCI进行交互，例如查找分支上最新的失败管道并获取日志等。

🚀 快速开始

模型上下文协议（MCP）是用于管理大型语言模型（LLMs）和外部系统之间上下文的新标准协议。本仓库为CircleCI提供了一个MCP服务器，借助它，你可以使用Cursor IDE或任何MCP客户端，通过自然语言完成与CircleCI交互的事情。

✨ 主要特性

支持的工具

• get_build_failure_logs：从CircleCI构建中检索详细的失败日志。该工具支持两种使用方式：
  • 使用CircleCI URL：提供一个失败作业URL或管道URL，例如获取https://app.circleci.com/pipelines/github/org/repo/123的日志。
  • 使用本地项目上下文：在本地工作区中使用工作区根路径、Git远程URL和分支名称等信息，例如查找我当前分支上最新的失败管道。

该工具返回的格式化日志包含作业名称、执行步骤的详细信息、失败消息和上下文，可用于调试构建失败、分析测试失败、调查部署问题以及快速访问构建日志而不离开IDE。

📦 安装指南

先决条件

• 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 URL获取日志的示例：

获取https://app.circleci.com/pipelines/github/org/repo/123的日志

高级用法

以下是使用get_build_failure_logs工具通过本地项目上下文查找当前分支上最新的失败管道的示例：

查找我当前分支上最新的失败管道

📚 详细文档

开发

入门

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 inspector迭代MCP服务器的最简单方法。你可以了解有关MCP inspector的更多信息此处

1. 启动开发服务器：

pnpm watch # 保持此终端运行

2. 在另一个终端启动inspector：

pnpm inspector

3. 配置环境：
   • 将你的CIRCLECI_TOKEN添加到环境变量部分中。
   • 令牌需要对CircleCI项目具有读取访问权限。
   • 可选设置你的CircleCI Base URL。默认为https//circleci.com

贡献

查看更多关于贡献的指南：CONTRIBUTING.md

📄 许可证

本项目遵循的许可证信息请查看：GitHub