Circleci MCP Server

🚀 圈CI 服务器

圈CI 服务器是基于MCP（机器学习配置协议）构建的实用工具，为开发者提供便捷的CircleCI相关功能支持，能帮助开发者高效处理CircleCI项目。

🚀 快速开始

圈CI 服务器能助力开发者更便捷地使用CircleCI，以下是使用该服务器的一些基本信息。

✨ 主要特性

圈CI 服务器目前提供了以下几种实用工具：

• 获取构建失败日志：可从CircleCI获取构建失败的日志信息，既支持通过URL直接访问，也能在本地项目环境中使用。
• 查找 flakes 测试：分析CircleCI项目中的历史测试执行数据，识别出 flaky（易变）的测试用例，并提供详细信息。
• 配置助手：验证和指导CircleCI配置文件的编写，帮助开发者避免配置错误并提高配置效率。

📦 安装指南

按照以下步骤进行安装：

1. 克隆仓库:

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

2. 安装依赖:

   pnpm install
   

3. 构建项目:

   pnpm build
   

📚 详细文档

开发指南

1. 启动开发服务器:

   pnpm watch # 保持在终端运行
   

2. 使用MCP Inspector进行调试
   在另一终端启动Inspector:

   pnpm inspector
   

   • 添加CIRCLECI_TOKEN到环境变量中，确保token具有访问CircleCI项目的权限。
   • 可选: 配置CircleCI基础URL，默认为https//circleci.com

测试指南

1. 运行测试套件:

   pnpm test
   

2. 开发模式下的实时测试:

   pnpm test:watch
   

更多详细的贡献指南，请参考CONTRIBUTING.md

功能详解

获取构建失败日志

该工具支持以下两种使用方式:

1. 通过CircleCI URL直接获取
   示例:"获取https://app.circleci.com/pipelines/github/org/repo/123的构建日志"
2. 在本地项目环境中使用
   提供工作区根路径、Git远程URL和分支名称即可。 返回的日志信息包括:

• 作业名称
• 执行步骤详情
• 失败消息及上下文

查找 flaky 测试

通过分析CircleCI项目的测试执行历史数据，识别出易变的测试用例，并提供详细信息。支持以下两种方式:

1. 通过项目URL直接获取
   示例:"在https://app.circleci.com/pipelines/github/org/repo中查找flaky测试"
2. 在本地项目环境中使用
   提供工作区根路径和Git远程URL即可。 返回的详细信息包括:

• 测试名称及文件位置
• 失败消息及上下文

配置助手

1. 验证CircleCI配置文件
   检查.circleci/config.yml文件是否存在语法或语义错误。
   示例:"验证我的CircleCI配置" 返回的信息包括:

• 详细的验证结果
• 配置建议