Circleci MCP Server

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

返回的信息包括：

• 詳細的驗證結果
• 配置建議