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.
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
📋 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:
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_KEY
in the.env
file
⚠️ 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
🛠️ Available MCP Tools
Basic Tools
Tool Name | Description |
---|---|
server_info | Display server information and configuration status |
health_check | Check server and Redmine connection health status |
Issue Operations
Tool Name | Description |
---|---|
get_issue | Get detailed information of specified issue |
create_new_issue | Create a new issue |
update_issue_status | Update issue status |
update_issue_content | Update issue content (title, description, etc.) |
add_issue_note | Add notes to issues |
assign_issue | Assign or unassign issues |
close_issue | Close issue and set completion rate |
Query Tools
Tool Name | Description |
---|---|
list_project_issues | List issues in projects |
get_my_issues | Get list of issues assigned to me |
search_issues | Search for issues containing keywords |
get_projects | Get list of accessible projects |
get_issue_statuses | Get all available issue statuses |
get_trackers | Get all available tracker lists |
get_priorities | Get all available issue priorities |
get_time_entry_activities | Get all available time tracking activities |
get_document_categories | Get all available document categories |
💡 Usage Examples
Using in Claude Code
🧪 Testing
Run Test Suite
Docker Environment Testing
If you want to test in a local Docker environment:
🔍 Troubleshooting
Common Issues
1. API Authentication Failed (401/403 errors)
- Verify API key is correct
- Check if Redmine has REST API enabled: Go to
Administration
→Settings
→API
, check "Enable REST web service" - Verify user permissions are sufficient
- Check if URL is correct (including http/https and port)
2. Connection Timeout
- Check network connection
- Adjust
REDMINE_TIMEOUT
environment variable - Verify Redmine server status
3. Issue Creation Failed
- Verify project exists and has permissions
- Check if required fields are filled
- Verify tracker and status settings
- Check basic data configuration: Ensure roles, trackers, statuses, and workflow setup is complete
- Verify user has appropriate role and permissions in the project
4. Status Update Failed
- Check if workflow allows the status transition
- Verify user role has permission to change status
- Verify target status ID is correct
5. Project or Issue Not Found
- Verify ID is correct
- Check if user has permission to view the project/issue
- Verify project status is active
Debug Mode
Enable debug mode for more detailed error information:
📁 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.
🔗 Related Links
If you have any questions or suggestions, feel free to open an Issue or contact the project maintainers.
remote-capable server
The server can be hosted and run remotely because it primarily relies on remote services or has no dependency on the local environment.
Tools
A Model Context Protocol server that enables Claude Code to directly interact with Redmine project management systems, supporting issue management, project operations, and search features.
- 🚀 Features
- 📋 System Requirements
- 🔧 Installation & Setup
- 🔗 Claude Code Integration
- 🛠️ Available MCP Tools
- 💡 Usage Examples
- 🧪 Testing
- 🔍 Troubleshooting
- 📁 Project Structure
- 🤝 Contributing
- 📄 License
- 🔗 Related Links
Related Resources
Related MCP Servers
- AsecurityAlicenseAqualityA Model Context Protocol server for interacting with Redmine using its REST API, enabling the management of tickets, projects, and user data through integration with LLMs.Last updated -2340TypeScriptMIT License
- -securityAlicense-qualityA Model Context Protocol server that allows Claude to interact with Linear's API for managing teams, issues, projects, and cycles.Last updated -301TypeScriptMIT License
- -securityFlicense-qualityA Model Context Protocol server that enables Claude to manage software development projects with complete context awareness and code execution through Docker environments.Last updated -1Python
- AsecurityAlicenseAqualityAn implementation of Claude Code as a Model Context Protocol server that enables using Claude's software engineering capabilities (code generation, editing, reviewing, and file operations) through the standardized MCP interface.Last updated -886JavaScriptMIT License