Jenkins Server MCP

🚀 Jenkins サーバー MCP

Jenkins CI/CD サーバーとの相互作用ツールを提供する Model Context Protocol (MCP) サーバーです。このサーバーにより、AI アシスタントは標準化されたインターフェースを通じて、ビルドの状態を確認し、ビルドをトリガーし、ビルドログを取得することができます。

🚀 クイックスタート

この Jenkins サーバー MCP を使用することで、AI アシスタントは Jenkins サーバーとのやり取りをスムーズに行うことができます。以下に、インストール、設定、使用方法の詳細を説明します。

📦 インストール

1. リポジトリをクローンします:

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

2. 依存関係をインストールします:

npm install

3. プロジェクトをビルドします:

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 ファイルを参照してください。