Redmine MCP Server
Provides comprehensive access to Redmine's REST API, enabling management of issues, projects, users, time entries, wiki pages, news, files, attachments, and more, with support for read-only mode and feature flags to selectively disable tool groups.
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 Serverget details for issue #42"
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
Model Context Protocol (MCP) server for Redmine that provides comprehensive access to the Redmine REST API.
Overview
This project is an MCP server that comprehensively covers Redmine's REST API. It allows you to operate Redmine from MCP clients (such as Claude Desktop).
Demonstration
Here are example videos showing how to use the Redmine MCP server with Claude Desktop:
Creating an Issue
https://github.com/user-attachments/assets/075fb079-104c-404d-91f5-755b3882853b
This demonstration also uses the Playwright MCP for browser automation alongside the Redmine MCP server.
Getting Issue Information
https://github.com/user-attachments/assets/8f551082-6982-4513-8fe7-b0f111be982d
Features
📋 Comprehensive API Coverage: Supports all functions available in Redmine's REST API
🔒 Read-Only Mode: Supports safe data reference mode
🎛️ Feature Flags: Selectively disable tool groups via environment variables
Prerequisites
Getting Redmine API Key
Log in to Redmine with administrator privileges
Go to "Administration" → "Settings" → "API" tab
Check "Enable REST web service"
Generate "API access key" in personal settings
For details, refer to Redmine REST API documentation.
Configuration
Environment Variables
The following environment variables are required (specified in MCP client configuration files):
REDMINE_URL (Required): Base URL of the Redmine instance
Example:
https://redmine.example.com
REDMINE_API_KEY (Required): API key generated in Redmine
Set the API key obtained in prerequisites
REDMINE_MCP_READ_ONLY (Optional): Enable read-only mode
true: Read-only mode (disables data modification operations)falseor unset: Allow all operations (default)
Feature Flags (Optional)
You can selectively disable tool groups to reduce the number of tools loaded by the MCP server. By default, all features are enabled. Set any of the following to true to disable a group:
Environment Variable | Tools Disabled |
| Issue relations (list, create, show, delete) |
| Time entries & activities (list, create, show, update, delete) |
| Versions (list, create, show, update, delete) |
| Watchers (add, remove) |
| Wiki pages (list, show, create/update, delete) |
| News (list, show, create, update, delete) |
| User management (list, show, create, update, delete, current user) |
| Group management (list, show, create, update, delete, add/remove user) |
| Memberships (list, show, create, update, delete) |
| Attachments (show, update, delete, upload/download, thumbnails) |
| Files (list, create) |
| Project management (list, show, create, update, delete, archive/unarchive, close/reopen) |
Full Configuration Example
You can copy and paste this into your MCP client configuration (e.g., claude_desktop_config.json).
Option 1: Using npx (no installation required)
{
"mcpServers": {
"redmine": {
"command": "npx",
"args": ["-y", "@compasify/redmine-mcp-server"],
"env": {
"REDMINE_URL": "https://your-redmine.example.com",
"REDMINE_API_KEY": "your-api-key-here",
"REDMINE_MCP_READ_ONLY": "false",
"REDMINE_MCP_DISABLE_RELATIONS": "false",
"REDMINE_MCP_DISABLE_TIME_ENTRIES": "false",
"REDMINE_MCP_DISABLE_VERSIONS": "false",
"REDMINE_MCP_DISABLE_WATCHERS": "false",
"REDMINE_MCP_DISABLE_WIKI": "false",
"REDMINE_MCP_DISABLE_NEWS": "false",
"REDMINE_MCP_DISABLE_USERS": "false",
"REDMINE_MCP_DISABLE_GROUPS": "false",
"REDMINE_MCP_DISABLE_MEMBERSHIPS": "false",
"REDMINE_MCP_DISABLE_ATTACHMENTS": "false",
"REDMINE_MCP_DISABLE_FILES": "false",
"REDMINE_MCP_DISABLE_PROJECTS": "false"
}
}
}
}Option 2: Using node with a local server.mjs file
Download server.mjs from the releases page and specify its local path:
{
"mcpServers": {
"redmine": {
"command": "node",
"args": [
"/path/to/server.mjs"
],
"env": {
"REDMINE_URL": "https://your-redmine.example.com",
"REDMINE_API_KEY": "your-api-key-here",
"REDMINE_MCP_READ_ONLY": "false",
"REDMINE_MCP_DISABLE_RELATIONS": "false",
"REDMINE_MCP_DISABLE_TIME_ENTRIES": "false",
"REDMINE_MCP_DISABLE_VERSIONS": "false",
"REDMINE_MCP_DISABLE_WATCHERS": "false",
"REDMINE_MCP_DISABLE_WIKI": "false",
"REDMINE_MCP_DISABLE_NEWS": "false",
"REDMINE_MCP_DISABLE_USERS": "false",
"REDMINE_MCP_DISABLE_GROUPS": "false",
"REDMINE_MCP_DISABLE_MEMBERSHIPS": "false",
"REDMINE_MCP_DISABLE_ATTACHMENTS": "false",
"REDMINE_MCP_DISABLE_FILES": "false",
"REDMINE_MCP_DISABLE_PROJECTS": "false"
}
}
}
}Windows example path:
"args": ["D:\\path\\to\\server.mjs"]
MCP Client Configuration
Using npx (Recommended for quick start)
Add the following as MCP configuration for your AI agent:
{
"mcpServers": {
"redmine": {
"command": "npx",
"args": ["-y", "@compasify/redmine-mcp-server"],
"env": {
"REDMINE_URL": "https://your-redmine.example.com",
"REDMINE_API_KEY": "your-api-key-here",
"REDMINE_MCP_READ_ONLY": "true"
}
}
}
}Using Docker (Alternative)
If you prefer using Docker:
{
"mcpServers": {
"redmine": {
"command": "docker",
"args": [
"run", "--rm", "-i",
"-e", "REDMINE_URL=https://your-redmine.example.com",
"-e", "REDMINE_API_KEY=your-api-key-here",
"-e", "REDMINE_MCP_READ_ONLY=true",
"ghcr.io/compasify/redmine-mcp-server:latest"
]
}
}
}When to use Docker:
Enterprise environments requiring container isolation
Reproducible deployments across different systems
Environments where Node.js installation is restricted
Below are specific configuration methods for several MCP clients:
Claude Desktop
Add the following to claude_desktop_config.json:
{
"mcpServers": {
"redmine": {
"command": "npx",
"args": ["-y", "@compasify/redmine-mcp-server"],
"env": {
"REDMINE_URL": "https://your-redmine.example.com",
"REDMINE_API_KEY": "your-api-key-here",
"REDMINE_MCP_READ_ONLY": "true"
}
}
}
}Claude Code
In Claude Code, you can add MCP servers using the following commands:
Local configuration:
claude mcp add redmine -e REDMINE_URL=https://your-redmine.example.com -e REDMINE_API_KEY=your-api-key-here -e REDMINE_MCP_READ_ONLY=true -- npx -y @compasify/redmine-mcp-serverProject configuration:
claude mcp add -s project redmine -e REDMINE_URL=https://your-redmine.example.com -e REDMINE_API_KEY=your-api-key-here -e REDMINE_MCP_READ_ONLY=true -- npx -y @compasify/redmine-mcp-serverUser configuration (global):
claude mcp add -s user redmine -e REDMINE_URL=https://your-redmine.example.com -e REDMINE_API_KEY=your-api-key-here -e REDMINE_MCP_READ_ONLY=true -- npx -y @compasify/redmine-mcp-serverVisual Studio Code
Project configuration (.vscode/mcp.json):
{
"servers": {
"redmine": {
"type": "stdio",
"command": "npx",
"args": ["-y", "@compasify/redmine-mcp-server"],
"env": {
"REDMINE_URL": "https://your-redmine.example.com",
"REDMINE_API_KEY": "your-api-key-here",
"REDMINE_MCP_READ_ONLY": "true"
}
}
}
}User configuration (settings.json):
{
"mcp": {
"servers": {
"redmine": {
"type": "stdio",
"command": "npx",
"args": ["-y", "@compasify/redmine-mcp-server"],
"env": {
"REDMINE_URL": "https://your-redmine.example.com",
"REDMINE_API_KEY": "your-api-key-here",
"REDMINE_MCP_READ_ONLY": "true"
}
}
}
}
}Available Features
This MCP server comprehensively supports the functions provided by Redmine's REST API:
Main Features
Issues: Create, update, delete, search, and manage related issues
Projects: Create, update, delete, archive, and manage memberships
Users: Create, update, delete, and manage groups
Time Entries: Record, update, and delete time entries
Wiki: Create, update, delete pages, and manage versions
News: Create, update, and delete news
Files: Upload and download files
Attachments: Upload, download files, and get thumbnails
Queries: Execute saved queries
Custom Fields: Get and manage custom fields
Roles: Get and manage roles
Trackers: Get and manage trackers
Issue Statuses: Get and manage issue statuses
Search: Cross-search functionality
Read-Only Mode
By setting REDMINE_MCP_READ_ONLY=true, you can disable data modification operations. This allows safe data reference.
License
MIT License
Author
Original Author
Acknowledgments
OpenAPI specification: d-yoshi/redmine-openapi
Code generation: Orval - TypeScript client and schema generator from OpenAPI
This server cannot be installed
Resources
Unclaimed servers have limited discoverability.
Looking for Admin?
If you are the server author, to access and configure the admin panel.
Latest Blog Posts
MCP directory API
We provide all the information about MCP servers via our MCP API.
curl -X GET 'https://glama.ai/api/mcp/v1/servers/compasify/redmine-mcp-server'
If you have feedback or need assistance with the MCP directory API, please join our Discord server