article
README
🚀 Jenkins API MCP 服务器
这是一个基于 Spring AI 的 MCP 服务,用于处理 Jenkins REST API 调用,为管理 Jenkins 作业提供常用操作接口,能有效提升 Jenkins 作业管理的便捷性和效率。
✨ 主要特性
- 作业管理:可对 Jenkins 作业进行创建、删除、启用/禁用、重命名等操作。
- 作业构建:支持触发构建、带参数构建以及停止构建等功能。
- 作业信息:能够获取作业信息、构建信息以及构建日志。
- 作业配置:可获取和更新作业配置。
🔧 技术细节
本项目采用的技术栈如下: | 属性 | 详情 | |------|------| | 模型类型 | 基于 Spring Boot 3.3.6 框架进行开发 | | 训练数据 | 使用 Jenkins REST API 客户端进行 API 调用,借助 Spring AI MCP Server 提供服务 |
🚀 快速开始
先决条件
- 需要 JDK 17 及以上版本。
- 需安装 Maven 3.6 及以上版本。
- 要使用启用了“远程访问 API”的 Jenkins 服务器。
构建项目
克隆仓库并进入项目目录:
git clone [仓库地址]
cd jenkins-mcp-server
在运行项目之前,使用 Maven 进行构建:
mvn package
构建成功后,在 /target 目录下会生成一个名为 mcp-jenkins-server-0.0.1-SNAPSHOT.jar 的文件。将此完整路径添加到您的 mcp.json 配置文件中:
{your_path}\\mcp-jenkins-server-0.0.1-SNAPSHOT.jar
mcp.json 配置
{
"mcpServers": {
"jenkins-mcp": {
"command": "java",
"args": [
"-jar",
"{your_path}\\mcp-jenkins-server-0.0.1-SNAPSHOT.jar"
],
"env": {
"JENKINS_API_SERVER_URI": "jenkins-uri",
"JENKINS_API_USERNAME": "用户名",
"JENKINS_API_TOKEN": "密码/令牌"
}
}
}
}
📄 API 文档
作业管理
createJob:创建一个新的 Jenkins 作业。deleteJob:删除一个现有的 Jenkins 作业。enableJob:启用一个被禁用的 Jenkins 作业。disableJob:禁用一个已启用的 Jenkins 作业。renameJob:重命名一个现有的 Jenkins 作业。
作业构建
buildJob:触发一个作业的构建。buildJobWithParams:带参数地触发构建。killJob:停止正在运行的构建。
作业信息
getJobInfo:获取作业的详细信息。getBuildInfo:获取特定构建的信息。getBuildLog:获取构建的控制台输出日志。getLastBuildNumber:获取最后一个构建编号。getLastBuildTimestamp:获取最后一个构建的时间戳。
作业配置
getJobConfig:获取作业的配置 XML。updateJobConfig:更新作业的配置。
微信扫一扫