🚀 圈CI 服务器

圈CI 服务器是基于MCP（机器学习配置协议）构建的工具，为开发者提供便捷的CircleCI相关功能支持，能助力开发者高效处理构建日志、识别不稳定测试用例以及优化配置文件。

🚀 快速开始

圈CI 服务器提供了获取构建失败日志、查找flakes 测试、配置助手等实用工具，帮助开发者更好地使用CircleCI。你可以按照以下步骤进行安装和使用。

📦 安装指南

1. 克隆仓库：

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

2. 安装依赖：

pnpm install

3. 构建项目：

pnpm build

💻 使用示例

基础用法

获取构建失败日志

# 通过CircleCI URL直接获取
# 示例: 获取https://app.circleci.com/pipelines/github/org/repo/123的构建日志
# 在本地项目环境中使用，需提供工作区根路径、Git远程URL和分支名称

查找 flaky 测试

# 通过项目URL直接获取
# 示例: 在https://app.circleci.com/pipelines/github/org/repo中查找flaky测试
# 在本地项目环境中使用，需提供工作区根路径和Git远程URL

配置助手

# 验证CircleCI配置文件
# 示例: 验证我的CircleCI配置

高级用法

开发模式

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配置”。

返回的信息包括：

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