🚀 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 文件以获取详细信息。