Skip to main content

A fork of lanbaoshen/mcp-jenkins. See original at https://github.com/lanbaoshen/mcp-jenkins.

Project description

MCP Jenkins Fork

Note: This project is a fork of lanbaoshen/mcp-jenkins, originally developed by Lanbao. It is distributed under the MIT License.

MCP Jenkins

PyPI Version PyPI - Downloads PyPI Downloads smithery badge test License

The Model Context Protocol (MCP) is an open-source implementation that bridges Jenkins with AI language models following Anthropic's MCP specification. This project enables secure, contextual AI interactions with Jenkins tools while maintaining data privacy and security.

Cursor Demo

cursor demo

Setup Guide

Installation

Choose one of these installation methods:

# Using uv (recommended)
pip install uv
uvx mcp-jenkins

# Using pip
pip install mcp-jenkins

# Using Smithery
npx -y @smithery/cli@latest install @lanbaoshen/mcp-jenkins --client claude

Configuration and Usage

Cursor

  1. Open Cursor Settings
  2. Navigate to MCP
  3. Click + Add new global MCP server

This will create or edit the ~/.cursor/mcp.json file with your MCP server configuration.

{
  "mcpServers": {
    "mcp-jenkins": {
      "command": "uvx",
      "args": [
        "mcp-jenkins",
        "--jenkins-url=xxx",
        "--jenkins-username=xxx",
        "--jenkins-password=xxx"
      ]
    }
  }
}

VSCode Copilot Chat

  1. Create .vscode folder with mcp.json file in you workspace for local setup or edit settings.json trough settings menù.
  2. Insert the following configuration:
{
    "servers": {
        "jenkins": {
            "url": "http://localhost:3000/sse",
            "type": "sse"
        }
    }
}
  1. Run the Jenkins MCP server with the following command:
uvx mcp-jenkins \
  --jenkins-url http://localhost:3000 \
  --jenkins-username your_username  \
  --jenkins-password your_password \
  --transport sse --port 3000

line arguments

# Stdio Mode
uvx mcp-jenkins --jenkins-url xxx --jenkins-username xxx --jenkins-password xxx --read-only

# SSE Mode
uvx mcp-jenkins --jenkins-url xxx --jenkins-username xxx --jenkins-password xxx --transport sse --port 9887

AutoGen

Install and exec

Install autogen:

pip install "autogen-ext[azure,ollama,openai,mcp]" autogen-chat

Run python scripts:

import asyncio

from autogen_ext.tools.mcp import StdioMcpToolAdapter, StdioServerParams
from autogen_agentchat.agents import AssistantAgent
from autogen_agentchat.ui import Console
from autogen_core import CancellationToken


async def main() -> None:
    # Create server params for the remote MCP service
    server_params = StdioServerParams(
        command='uvx',
        args=[
            'mcp-jenkins',
            '--jenkins-username',
            'xxx',
            '--jenkins-password',
            'xxx',
            '--jenkins-url',
            'xxx'
        ],
    )

    # Get the translation tool from the server
    adapter = await StdioMcpToolAdapter.from_server_params(server_params, 'get_all_jobs')

    # Create an agent that can use the translation tool
    agent = AssistantAgent(
        name='jenkins_assistant',
        model_client=[Replace_with_your_model_client],
        tools=[adapter],
    )

    # Let the agent translate some text
    await Console(
        agent.run_stream(task='Get all jobs', cancellation_token=CancellationToken())
    )


if __name__ == "__main__":
    asyncio.run(main())

Available Tools

Tool Description
get_all_jobs Get all jobs
get_job_config Get job config
search_jobs Search job by specific field
get_running_builds Get running builds
stop_build Stop running build
get_build_info Get build info
get_build_sourcecode Get the pipeline source code of a specific build in Jenkins
get_job_info Get job info
build_job Build a job with param
get_build_logs Get build logs
get_all_nodes Get nodes
get_node_config Get the config of node
get_all_queue_items Get all queue items
get_queue_item Get queue item info
cancel_queue_item Cancel queue item
get_multibranch_jobs Get all multibranch pipeline jobs from Jenkins, optionally filtered by patterns
get_multibranch_branches Get all branches for a specific multibranch pipeline job
scan_multibranch_pipeline Trigger a scan of a multibranch pipeline to discover new branches

Development & Debugging

# Using MCP Inspector
# For installed package
npx @modelcontextprotocol/inspector uvx mcp-jenkins --jenkins-url xxx --jenkins-username xxx --jenkins-password xxx

# For local development version
npx @modelcontextprotocol/inspector uv --directory /path/to/your/mcp-jenkins run mcp-jenkins --jenkins-url xxx --jenkins-username xxx --jenkins-password xxx

Pre-Commit Hook

# Install Dependency
uv sync --all-extras --dev
pre-commit install

# Manually execute
pre-commit run --all-files

UT

# Install Dependency
uv sync --all-extras --dev

# Execute UT
uv run pytest --cov=mcp_jenkins

License

Licensed under MIT - see LICENSE file. This is not an official Jenkins product.

MCP-Jenkins in MCP Registries

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mcp_jenkins_fork-0.3.6.tar.gz (13.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

mcp_jenkins_fork-0.3.6-py3-none-any.whl (15.2 kB view details)

Uploaded Python 3

File details

Details for the file mcp_jenkins_fork-0.3.6.tar.gz.

File metadata

  • Download URL: mcp_jenkins_fork-0.3.6.tar.gz
  • Upload date:
  • Size: 13.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.3

File hashes

Hashes for mcp_jenkins_fork-0.3.6.tar.gz
Algorithm Hash digest
SHA256 ebcd09e51dcffe1275a90f1e72631339c1f388bbc45956a0c5ff42cb9987185f
MD5 cce63611c8d3a95fdf2d29f78afab07b
BLAKE2b-256 8896c5b6fcfca346ebb9ed10a0d95b87bc9de255a2cbc5db6ca160e7d9e42d2b

See more details on using hashes here.

File details

Details for the file mcp_jenkins_fork-0.3.6-py3-none-any.whl.

File metadata

File hashes

Hashes for mcp_jenkins_fork-0.3.6-py3-none-any.whl
Algorithm Hash digest
SHA256 069cca1404b77fc8788aec86a4dc74bc7b9425db85780a78bce4cc34dbaba6f7
MD5 072fb57226f48594e56062c007758d40
BLAKE2b-256 743b3ac55693663c74826240be0f0bd6454feead660ada9eb1812e68dda3253a

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page