The Redmine MCP Server enables integration between Claude Code and Redmine for project and issue management.
Issue Management: Create, view, update (title, description, priority, done ratio, tracker, dates, estimated hours), assign, add notes (with optional time logging), and close issues
Project Management: List accessible projects and filter issues by project and status
Search Features: Search issues by keywords or view issues assigned to the current user
System Tools: Perform health checks, query available issue statuses, trackers, priorities, time tracking activities, and document categories
User Management: Search and list users, and get detailed user information
Cache Management: Manually refresh cached values and user data
Enables direct interaction with Redmine project management systems, providing comprehensive tools for issue management (querying, creating, updating, assigning, adding notes), project management (listing projects and their issues), search features (keyword search), and system tools for checking connection status.
Click on "Install Server".
Wait a few minutes for the server to deploy. Once ready, it will show a "Started" state.
In the chat, type
@followed by the MCP server name and your instructions, e.g., "@Redmine MCP Servershow me my open issues in the 'Website Redesign' project"
That's it! The server will respond to your query, and you can continue using it as needed.
Here is a step-by-step guide with screenshots.
Redmine MCP Server
A Model Context Protocol (MCP) server for Redmine integration, enabling Claude Code to directly interact with Redmine project management systems.
🚀 Features
✅ Issue Management
Query Issues: Get detailed issue information and lists
Create Issues: Create new issues and set related attributes
Update Issues: Modify issue content, status, priority, etc.
Assign Issues: Assign or unassign issues to specific users
Add Notes: Add public or private notes to issues
Close Issues: Automatically set issues to completed status
✅ Project Management
Project Lists: Get accessible project lists
Project Issues: Filter by status and list all issues in projects
✅ Search Features
Keyword Search: Search for keywords in issue titles and descriptions
My Issues: Quick view of issues assigned to current user
✅ System Tools
Health Check: Verify MCP server and Redmine connection status
Status Query: Get available issue status lists
Related MCP server: Linear MCP Server
📋 System Requirements
Python: 3.12 or higher
Redmine: Version with REST API support (recommended 4.0+)
Package Manager: uv or pip
🔧 Installation & Setup
1. Clone the Project
2. Install Dependencies
Using uv (recommended):
Or using pip:
3. Environment Configuration
Create a .env file:
Edit the .env file and set the following environment variables:
Environment Variables Reference
Variable | Description | Default | Example |
| Redmine server URL | Required |
|
| Your Redmine API key | Required |
|
| Log level for this MCP server |
|
|
| Request timeout (seconds) |
|
|
| Transport mode |
|
|
| SSE bind address |
|
|
| SSE listen port |
|
|
| Legacy log level (backward compatibility) | - |
|
| Legacy timeout (backward compatibility) | - |
|
Log Level Priority:
REDMINE_MCP_LOG_LEVEL(highest priority - project-specific)LOG_LEVEL(backward compatibility)INFO(default if neither is set)
Note: The system automatically handles case conversion and ensures FastMCP compatibility.
4. Redmine API Setup
4.1 Enable REST API
Log in to Redmine as administrator
Go to Administration → Settings → API
Check "Enable REST web service"
Click Save
4.2 Configure Redmine Basic Data (Administrator)
Before using MCP tools, you need to configure Redmine's basic data:
Configure Roles and Permissions
Go to Administration → Roles and permissions
Create or edit roles (e.g.: Developer, Tester, Project Manager)
Assign appropriate permissions to roles (recommend at least: View issues, Add issues, Edit issues)
Configure Trackers
Go to Administration → Trackers
Create tracker types (e.g.: Bug, Feature, Support)
Set default status and workflow for each tracker
Configure Issue Statuses
Go to Administration → Issue statuses
Create statuses (e.g.: New, In Progress, Resolved, Closed, Rejected)
Set status attributes (whether it's a closed status, etc.)
Configure Workflow
Go to Administration → Workflow
Set allowed status transitions for each role and tracker combination
Ensure basic status transition paths (New → In Progress → Resolved → Closed)
Create Projects
Go to Projects → New project
Set project name, identifier, description
Select enabled modules (at least enable "Issue tracking")
Assign members and set roles
4.3 Get API Key
Log in to your Redmine system (can be administrator or regular user)
Go to My account → API access key
Click Show or Reset to get the API key
Copy the key to
REDMINE_API_KEYin the.envfile
⚠️ Important Notes:
If you can't find the API key option, please ensure step 4.1 (Enable REST API) is completed
Complete basic setup before you can properly create and manage issues
📚 Detailed Setup Guide: For complete Redmine setup steps, please refer to Redmine Complete Setup Guide
🔗 Claude Code Integration
Install to Claude Code
Verify Installation
🌐 SSE Mode & Docker Deployment
Transport Modes
Redmine MCP supports two transport modes:
Mode | Use Case | Multi-Client | Deployment |
stdio (default) | Local CLI usage with Claude Code | ❌ Single | Auto-started by Claude Code |
sse | Team sharing, remote access, containerized | ✅ Multiple | Manual start required |
Running in SSE Mode
Quick Start (Development)
Global Installation
Using .env File
Create a .env file in your working directory:
Note:
uv runautomatically loads.envfrom the project directory. Global installation requires explicit environment variables or running from the directory containing.env.
Docker Deployment
Quick Start with Docker
Using Docker Compose
Docker Compose with .env file (Recommended)
Create
.envfile:
Update
docker-compose.ymlto use environment variables:
Start the service:
Connecting Claude Code to SSE Server
Once the SSE server is running, configure Claude Code to connect:
Or manually edit ~/.claude.json:
Note: Environment variables (
REDMINE_DOMAIN,REDMINE_API_KEY) are configured on the SSE server side, not in Claude Code.
🔄 Updating/Reinstalling MCP
If you need to update to the latest version of the MCP server or reinstall it:
Quick Update (Recommended)
Full Reinstallation
If quick update doesn't work, follow these steps:
1. Remove Previous Installation
2. Install Latest Version
3. Re-register with Claude Code
4. Verify Updated Installation
Troubleshooting Update Issues
Problem: Old version still running after update
This usually happens when PATH has multiple
redmine-mcpexecutablesSolution: Use full path in Claude Code MCP config
Problem: "Failed to reconnect to redmine" after update
Restart Claude Code completely (close and reopen)
Or use
/mcpcommand and selectrestartfor redmine server
Important Notes:
Always restart Claude Code after updating MCP server
Use
--force --reinstallflags to ensure clean installationCheck tool count in
/mcpto verify update (current: 26 tools)
🛠️ Available MCP Tools (26 tools)
Basic Tools
Tool Name | Description |
| Display server information and configuration status |
| Check server and Redmine connection health status |
| Manually refresh enum values and user cache |
Issue Operations
Tool Name | Description |
| Get detailed information of specified issue |
| Create a new issue (supports name parameters) |
| Update issue status |
| Update issue content (title, description, etc.) |
| Add notes to issues (supports time tracking) |
| Assign or unassign issues |
| Close issue and set completion rate |
Journal Tools
Tool Name | Description |
| List all journals/notes for an issue |
| Get detailed information of a specific journal |
Attachment Tools ✨ New
Tool Name | Description |
| Get attachment metadata (without downloading) |
| Download image for AI visual analysis (supports thumbnail) |
Query Tools
Tool Name | Description |
| List issues in projects |
| Get list of issues assigned to me |
| Search for issues containing keywords |
| Get list of accessible projects |
| Get all available issue statuses |
| Get all available tracker lists |
| Get all available issue priorities |
| Get all available time tracking activities |
| Get all available document categories |
User Tools
Tool Name | Description |
| Search users by name or login |
| List all users |
| Get detailed information of a specific user |
💡 Usage Examples
Using in Claude Code
🧪 Testing
Run Test Suite
Docker Environment Testing
If you want to test in a local Docker environment:
📁 Project Structure
🤝 Contributing
Fork this project
Create a feature branch (
git checkout -b feature/amazing-feature)Commit your changes (
git commit -m 'Add some amazing feature')Push to the branch (
git push origin feature/amazing-feature)Open a Pull Request
📄 License
This project is licensed under the MIT License - see the LICENSE file for details.
📦 Changelog
See CHANGELOG.md for version history and release notes.
🔗 Related Links
If you have any questions or suggestions, feel free to open an Issue or contact the project maintainers.