README
🚀 MCP Jenkins
MCP Jenkins是一个开源实现,它将Jenkins与遵循Anthropic MCP规范的AI语言模型连接起来,使安全、上下文化的AI与Jenkins工具交互成为可能,同时能保持数据隐私和安全性。
🚀 快速开始
本项目可将Jenkins与遵循Anthropic MCP规范的AI语言模型相连接,下面为您介绍其安装和使用方法。
✨ 主要特性
- 实现Jenkins与遵循Anthropic MCP规范的AI语言模型的连接。
- 支持安全、上下文化的AI与Jenkins工具交互,保障数据隐私和安全性。
- 提供多种安装方式和使用模式,如Cursor模式、标准输入模式和脚本模式。
📦 安装指南
安装方法
您可以选择以下其中一种安装方式:
# 使用uv(推荐)
pip install uv
uvx mcp-jenkins
# 使用pip
pip install mcp-jenkins
# 使用Smithery
npx -y @smithery/cli@latest install @lanbaoshen/mcp-jenkins --client claude
配置与使用
Cursor
- 打开Cursor设置。
- 导航到MCP。
- 点击+添加新的全局MCP服务器。
这将创建或编辑~/.cursor/mcp.json文件,其中包含您的MCP服务器配置。
{
"mcpServers": {
"mcp-jenkins": {
"command": "uvx",
"args": [
"mcp-jenkins",
"--jenkins-url=xxx",
"--jenkins-username=xxx",
"--jenkins-password=xxx"
]
}
}
}
标准输入模式
# 标准输入模式
uvx mcp-jenkins --jenkins-url=xxx --jenkins-username=xxx --jenkins-password=xxx
# 交互式控制台模式(可选)
uvx mcp-jenkins --console
脚本模式
from mcp_jenkins import JenkinsMCP
jenkins = JenkinsMCP(
jenkins_url="http://your-jenkins-url:8080",
username="your-username",
password="your-password"
)
# 执行构建作业
result = jenkins.build_job("my-job")
print(result)
💻 使用示例
基础用法
以下是使用脚本模式执行构建作业的示例:
from mcp_jenkins import JenkinsMCP
jenkins = JenkinsMCP(
jenkins_url="http://your-jenkins-url:8080",
username="your-username",
password="your-password"
)
# 执行构建作业
result = jenkins.build_job("my-job")
print(result)
高级用法
您可以根据需要调用不同的工具,如获取构建状态、触发新的构建作业等。
from mcp_jenkins import JenkinsMCP
jenkins = JenkinsMCP(
jenkins_url="http://your-jenkins-url:8080",
username="your-username",
password="your-password"
)
# 获取指定作业的构建状态
status = jenkins.get_build_status("my-job")
print(status)
# 触发新的构建作业
jenkins.trigger_build("my-job")
📚 详细文档
工具列表
以下是一些可用的工具:
- build_job:构建指定的Jenkins作业。
- get_build_status:获取指定作业的构建状态。
- trigger_build:触发新的构建作业。
🔧 技术细节
开发与调试
预提交钩
# 安装依赖项
uv sync --all-extras --dev
pre-commit install
# 手动执行
pre-commit run --all-files
单元测试
# 安装依赖项
uv sync --all-extras --dev
# 执行UT
uv run pytest --cov=mcp_jenkins
📄 许可证
本项目根据MIT许可证发布,详情见LICENSE文件。需要注意的是,这不是官方的Jenkins产品。
Scan to contact