
joaoperfig/redmine_mcp_plugin
Developer toolsЭта страница переведена автоматически. Технические детали смотрите в оригинале. Открыть оригинал
Redmine MCP server that runs as a plugin, so a separate service is not needed
Обзор
Connect MCP clients to the projects, issues, wikis, and users already managed by Redmine. The plugin runs inside the Redmine process and exposes a Streamable HTTP endpoint at POST /mcp; it uses Redmine's own users, authentication, permissions, visibility rules, settings, and database instead of creating a parallel service. Every tool runs as the authenticated Redmine user. Redmine permissions and record visibility limit what that user can access, and OAuth2 scopes can narrow access further. The endpoint is disabled after installation and, once enabled, starts in read-only mode. Redmine 6.1 or later is required. From the root of a compatible Redmine checkout, place this repository at plugins/redmine_mcp_plugin, install dependencies, and run the required plugin migration: Restart the Redmine application using the procedure for your deployment. Redmine supplies the supported Ruby, Rails, database, and application-server environment; this plugin is not a standalone Rails application.
README
Показан фрагмент оригинального README. Открыть оригинал.
Redmine MCP Server
Connect MCP clients to the projects, issues, wikis, and users already managed by
Redmine. The plugin runs inside the Redmine process and exposes a Streamable HTTP
endpoint at POST /mcp; it uses Redmine’s own users, authentication, permissions,
visibility rules, settings, and database instead of creating a parallel service.
Every tool runs as the authenticated Redmine user. Redmine permissions and record visibility limit what that user can access, and OAuth2 scopes can narrow access further. The endpoint is disabled after installation and, once enabled, starts in read-only mode.
Quickstart
1. Install the plugin
Redmine 6.1 or later is required. From the root of a compatible Redmine checkout,
place this repository at plugins/redmine_mcp_plugin, install dependencies, and
run the required plugin migration:
git clone https://github.com/joaoperfig/redmine_mcp_plugin.git plugins/redmine_mcp_plugin
bundle install
bin/rails redmine:plugins:migrate NAME=redmine_mcp_plugin RAILS_ENV=production
Restart the Redmine application using the procedure for your deployment. Redmine supplies the supported Ruby, Rails, database, and application-server environment; this plugin is not a standalone Rails application.
2. Enable and configure the endpoint
For the shortest first connection, use a Redmine API key:
- In Administration > Settings > API, enable the REST web service.
- In Administration > Plugins > Redmine MCP Server > Configure, enable the MCP endpoint. Leave REST API key and Read-only mode enabled.
- Save the settings, then copy an active Redmine user’s API access key from that user’s My account page.
The REST API setting is also required for OAuth2 and HTTP Basic authentication. Session-cookie authentication does not depend on it.
3. Configure an MCP client
Point the client at the Redmine base URL followed by /mcp and send the user’s API
key in X-Redmine-API-Key. A typical HTTP MCP configuration looks like this:
{
"mcpServers": {
"redmine": {
"type": "http",
"url": "https://redmine.example.com/mcp",
"headers": {
"X-Redmine-API-Key": "YOUR_API_KEY"
}
}
}
}
Configuration keys vary by client. If the client manages OAuth2 authorization, omit the API-key header and use the OAuth flow described under Authentication.
4. Verify the connection
Call the read-only whoami tool directly to confirm the endpoint, credentials,
and effective server mode:
curl --fail-with-body https://redmine.example.com/mcp \
--header 'Content-Type: application/json' \
--header 'Accept: application/json, text/event-stream' \
--header 'MCP-Protocol-Version: 2026-07-28' \
--header 'Mcp-Method: tools/call' \
--header 'Mcp-Name: whoami' \
--header 'X-Redmine-API-Key: YOUR_API_KEY' \
Установка
This server does not publish a one-line install command.
Open the repository installation guide Новичок в MCP? Начните с руководства на mcpskill.org →Конфигурация
{
"mcpServers": {
"redmine": {
"type": "http",
"url": "https://redmine.example.com/mcp",
"headers": {
"X-Redmine-API-Key": "YOUR_API_KEY"
}
}
}
}