
Jenkins MCP Server
β 1from ddang-jung
An MCP server for automating tasks and managing jobs on a Jenkins server.
Jenkins MCP Server
A Model Context Protocol (MCP) server that enables Claude to interact with Jenkins through various automation tools. This server provides comprehensive Jenkins management capabilities including job monitoring, build control, and queue management.
Features
- Job Management: List jobs, get job configurations, and monitor job status
- Build Control: Trigger builds with parameters, stop running builds, and check build status
- Build History: Retrieve build history and detailed build information
- Console Logs: Access build console output for debugging
- Queue Management: Monitor Jenkins build queue and stuck builds
- Folder Support: Navigate Jenkins folders and organizational structures
Available Tools
1. get_build_status
Get the status of a specific Jenkins build.
Parameters:
jobPath(required): Path to the Jenkins job (e.g., "job/MyProject/job/main")buildNumber(optional): Build number or "lastBuild" for most recent
Example:
{
"jobPath": "job/MyProject",
"buildNumber": "lastBuild"
}2. trigger_build
Trigger a new Jenkins build with optional parameters.
Parameters:
jobPath(required): Path to the Jenkins jobparameters(optional): Build parameters as key-value pairs
Example:
{
"jobPath": "job/MyProject",
"parameters": {
"BRANCH": "main",
"DEPLOY_ENV": "staging"
}
}3. get_build_log
Retrieve the console output of a specific build.
Parameters:
jobPath(required): Path to the Jenkins jobbuildNumber(required): Build number or "lastBuild"
4. list_jobs
List all Jenkins jobs in a folder or at root level.
Parameters:
folderPath(optional): Path to folder (e.g., "job/MyFolder") or empty for root
5. get_build_history
Get build history for a specific Jenkins job.
Parameters:
jobPath(required): Path to the Jenkins joblimit(optional): Number of recent builds to retrieve (default: 10)
6. stop_build
Stop a running Jenkins build.
Parameters:
jobPath(required): Path to the Jenkins jobbuildNumber(required): Build number or "lastBuild"
7. get_queue
Get the current Jenkins build queue status.
Parameters: None
8. get_job_config
Get the configuration details of a Jenkins job.
Parameters:
jobPath(required): Path to the Jenkins job
Job Path Format
Jenkins job paths follow this format:
- Root level job:
job/JobName - Folder job:
job/FolderName/job/JobName - Multi-level:
job/Folder1/job/Folder2/job/JobName
Error Handling
The server provides comprehensive error handling:
- Authentication errors: Check your Jenkins credentials
- Job not found: Verify the job path format
- Permission errors: Ensure your Jenkins user has appropriate permissions
- Network errors: Check Jenkins server connectivity
Development
Project Structure
jenkins-mcp-server/
βββ src/
β βββ index.ts # Main server implementation
βββ build/ # Compiled JavaScript output
βββ package.json # Project configuration
βββ tsconfig.json # TypeScript configuration
βββ .gitignore # Git ignore rules
βββ README.md # This fileScripts
npm run build: Compile TypeScript to JavaScriptnpm run watch: Watch for changes and rebuildnpm run inspector: Start MCP Inspector for debuggingnpm run prepare: Prepare build (runs automatically)npm run clean: Clean build artifacts and dependencies (macOS/Linux)npm run clean:win: Clean build artifacts and dependencies (Windows)
Cleaning Project
To reset the project to its initial state (remove build artifacts and dependencies):
macOS/Linux:
npm run clean
# or manually:
rm -rf node_modules build package-lock.jsonWindows:
npm run clean:win
# or manually:
rmdir /s /q node_modules & rmdir /s /q build & del package-lock.jsonnpm installBefore it works, you'll need: JENKINS_URLJENKINS_USERJENKINS_TOKEN
Installation
- Clone the repository:
git clone https://github.com/ddang-jung/jenkins-mcp-server.git
cd jenkins-mcp-server- Install dependencies:
npm install- Build the project:
npm run buildConfiguration
Environment Variables
Set the following environment variables for Jenkins authentication:
JENKINS_URL: Your Jenkins server URL (e.g.,http://localhost:8080)JENKINS_USER: Your Jenkins usernameJENKINS_TOKEN: Your Jenkins API token (recommended) or password
Getting Jenkins API Token
- Log into Jenkins
- Go to Manage Jenkins β Manage Users β Click your username
- Click Configure β API Token β Add new Token
- Copy the generated token
Git Configuration
The project includes a comprehensive .gitignore file that excludes:
- Build artifacts (
build/,dist/) - Dependencies (
node_modules/) - Environment variables (
.env*) - Jenkins credentials and configuration files
- IDE files (
.vscode/,.idea/) - System files (
.DS_Store,Thumbs.db)
Important: Never commit Jenkins credentials or API tokens to version control.
Claude Desktop Configuration
Add this configuration to your claude_desktop_config.json:
{
"mcpServers": {
"jenkins": {
"command": "node",
"args": ["/path/to/jenkins-mcp-server/build/index.js"],
"env": {
"JENKINS_URL": "http://your-jenkins-server:8080",
"JENKINS_USER": "your-username",
"JENKINS_TOKEN": "your-api-token"
}
}
}
}Usage
Starting the Server
npm startThe server runs on stdio and communicates with Claude through the MCP protocol.
Development Mode
For development with auto-rebuild:
npm run watchFor debugging with MCP Inspector:
npm run inspectorTroubleshooting
Common Issues
- "Jenkins API error": Check your Jenkins URL and credentials
- "Job not found": Verify the job path format (use
job/prefix) - "Permission denied": Ensure your Jenkins user has required permissions
- "Connection refused": Check if Jenkins server is running and accessible
Debug Mode
Enable debug logging by setting:
export DEBUG=jenkins-mcp-serverFor more information, visit the Jenkins REST API documentation.
Licensed under MITβ you can use, modify, and redistribute it under that license's terms.
License
This project is licensed under the MIT License.