Jenkins Server MCP

🚀 Jenkins 服務器 MCP

Jenkins 服務器 MCP 是一個基於 Model Context Protocol (MCP) 的服務器，它提供了與 Jenkins CI/CD 服務器交互的工具。藉助該服務器，AI 助手能夠通過標準化接口檢查構建狀態、觸發構建以及獲取構建日誌，極大地提升了與 Jenkins 服務器交互的便捷性和效率。

🚀 快速開始

Jenkins 服務器 MCP 為 AI 助手與 Jenkins CI/CD 服務器的交互提供了便利，以下將詳細介紹其安裝、配置和使用方法。

📦 安裝指南

克隆倉庫

git clone https://github.com/yourusername/jenkins-server-mcp.git
cd jenkins-server-mcp

安裝依賴項

npm install

構建項目

npm run build

🛠️ 配置說明

服務器需要配置以下環境變量：

• JENKINS_URL：Jenkins 服務器的 URL（默認為 'http://sohoci.rd.tp-link.net/jenkins'）
• JENKINS_USER：Jenkins 登錄用戶名
• JENKINS_TOKEN：Jenkins API 訪問令牌

您可以在 MCP 設置文件中配置這些變量：

對於 Claude Desktop

• MacOS：~/Library/Application Support/Claude/claude_desktop_config.json
• Windows：%APPDATA%/Claude/claude_desktop_config.json

{
  "mcpServers": {
    "jenkins-server": {
      "command": "node",
      "args": ["/path/to/jenkins-server-mcp/build/index.js"],
      "env": {
        "JENKINS_URL": "https://your-jenkins-server.com",
        "JENKINS_USER": "your-username",
        "JENKINS_TOKEN": "your-api-token"
      }
    }
  }
}

💻 使用示例

基礎用法

1. 獲取構建狀態

獲取 Jenkins 構建的狀態：

// 示例用法
const result = await mcpClient.useTool("jenkins-server", "get_build_status", {
  jobPath: "view/xxx_debug",
  buildNumber: "lastBuild"  // 可選， defaults to lastBuild
});

輸入模式：

{
  "jobPath": "string",  // Jenkins 作業路徑
  "buildNumber": "string"  // 可選，構建編號或 "lastBuild"
}

2. 觸發構建

觸發新的 Jenkins 構建並傳遞參數：

// 示例用法
const result = await mcpClient.useTool("jenkins-server", "trigger_build", {
  jobPath: "view/xxx_debug",
  parameters: {
    BRANCH: "main",
    BUILD_TYPE: "debug"
  }
});

輸入模式：

{
  "jobPath": "string",  // Jenkins 作業路徑
  "parameters": {
    // 構建參數，鍵值對形式
  }
}

3. 獲取構建日誌

檢索 Jenkins 構建的控制檯輸出：

// 示例用法
const result = await mcpClient.useTool("jenkins-server", "get_build_log", {
  jobPath: "view/xxx_debug",
  buildNumber: "lastBuild"
});

輸入模式：

{
  "jobPath": "string",  // Jenkins 作業路徑
  "buildNumber": "string"  // 構建編號或 "lastBuild"
}

🛠️ 開發與調試

開發

使用自動重建進行開發：

npm run watch

調試

由於 MCP 服務器通過 stdio 進行通信，您可以使用 MCP Inspector 進行調試：

npm run inspector

這將提供一個訪問調試工具的 URL，在您的瀏覽器中打開即可。

📄 許可證

該項目遵循 MIT 許可證 - 請參閱 LICENSE 文件以獲取詳細信息。