MCP Server Circleci

🚀 圈CI服務器

CircleCI服務器是一款支持多種工具的MCP（多語言平臺計算）服務器，它能夠集成到各類開發環境中，有效提升開發者的工作效率。

🚀 快速開始

入門

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檢查器。有關MCP檢查器的更多信息，請訪問https://modelcontextprotocol.io/docs/tools/inspector

1. 運行開發服務器：

pnpm watch # 保持此終端運行

2. 在另一個終端中啟動檢查器：

pnpm inspector

3. 配置環境：

• 在檢查器UI的“環境變量”部分添加你的CIRCLECI_TOKEN
• 令牌需要對你的CircleCI項目具有讀取訪問權限
• 可選地，你可以設置CircleCI基礎URL。默認為https//circleci.com

✨ 主要特性

獲取構建失敗日誌

從CircleCI中檢索構建失敗的日誌。該功能有兩種使用方式：

1. 使用CircleCI鏈接：
   • 提供一個失敗的任務鏈接或管道鏈接
   • 示例："獲取https://app.circleci.com/pipelines/github/org/repo/123的構建日誌"
2. 使用本地項目上下文：
   • 通過指定工作區根路徑、Git遠程URL和分支名稱從本地工作區中檢索信息
   • 示例："查找當前分支上的最新失敗管道"

該工具返回格式化的日誌，包括：

• 任務名稱
• 執行步驟的詳細信息
• 失敗消息和上下文

這對於調試構建失敗、分析測試失敗、調查部署問題以及快速訪問構建日誌而不離開IDE非常有用。

查找易變測試

通過分析測試執行歷史，識別CircleCI項目中的易變測試。該功能利用了此處描述的CircleCI的易變測試檢測功能：https://circleci.com/blog/introducing-test-insights-with-flaky-test-detection/#flaky-test-detection

該工具有兩種使用方式：

1. 使用CircleCI項目鏈接：
   • 直接提供項目的鏈接
   • 示例："查找https://app.circleci.com/pipelines/github/org/repo中的易變測試"
2. 使用本地項目上下文：
   • 通過指定工作區根路徑和Git遠程URL從本地工作區中檢索信息
   • 示例："查找當前項目中的易變測試"

工具返回詳細信息，包括：

• 測試名稱和文件位置
• 失敗消息和上下文

這有助於：

• 識別測試套件中的不穩定測試
• 獲取有關測試失敗的詳細上下文
• 做出數據驅動的決策以改進測試

配置助手

通過提供指導和驗證來協助CircleCI配置任務。該工具幫助你：

1. 驗證CircleCI配置：
   • 檢查項目的.circleci/config.yml文件是否存在語法或語義錯誤
   • 示例："驗證我的CircleCI配置"

工具提供：

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

這有助於：

• 在推送之前捕獲配置錯誤
• 學習CircleCI配置的最佳實踐
• 調試配置問題
• 正確實施CircleCI功能

📦 安裝指南

1. 克隆倉庫：

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

2. 安裝依賴項：

pnpm install

3. 構建項目：

pnpm build

💻 使用示例

基礎用法

獲取構建失敗日誌（使用CircleCI鏈接）

獲取https://app.circleci.com/pipelines/github/org/repo/123的構建日誌

獲取構建失敗日誌（使用本地項目上下文）

查找當前分支上的最新失敗管道

查找易變測試（使用CircleCI項目鏈接）

查找https://app.circleci.com/pipelines/github/org/repo中的易變測試

查找易變測試（使用本地項目上下文）

查找當前項目中的易變測試

驗證CircleCI配置

驗證我的CircleCI配置

📚 詳細文檔

有關更詳細的貢獻指南，請參閱CONTRIBUTING.md

🔧 技術細節

暫未提供相關技術細節，後續可進一步補充。

📄 許可證

暫未提供相關許可證信息，後續可進一步補充。