# MCP-For-Redmine · [](https://github.com/toss/slash/blob/main/LICENSE)
English | [한국어](./README-ko_kr.md) | [日本語](./README-ja_jp.md) | [简体中文](./README-zh_cn.md)
This project is a Model-Context-Protocol (MCP) server for interacting with Redmine. With an MCP-compatible client, you can easily manage Redmine projects, issues, users, and time entries.
Currently, only the standard input/output (`stdio`) transport is supported.
## Requirements
- Node.js 18 or higher
- Redmine API key (your personal API key from your Redmine account)
Compatibility baseline: Redmine 6.0.6
## Getting Started
How to configure the MCP server for each environment:
Cursor
File (top-left) -> Preferences -> Cursor Settings -> MCP & Integrations -> New MCP Server
Config file: `~/.cursor/mcp.json` (global) or `.cursor/mcp.json` (per-project)
📚 Docs: [Cursor MCP documentation](https://docs.cursor.com/en/context/mcp)
[](https://cursor.com/en/install-mcp?name=mcp-for-redmine&config=eyJjb21tYW5kIjoibnB4IC15IEBjaHNwb3dlcjEvbWNwLWZvci1yZWRtaW5lQGxhdGVzdCIsImVudiI6eyJSRURNSU5FX0JBU0VfVVJMIjoiaHR0cHM6Ly95b3VyLnJlZG1pbmUudGxkIiwiUkVETUlORV9BUElfS0VZIjoieW91cl9hcGlfa2V5X2hlcmUifX0%3D)
```json
{
"mcpServers": {
"mcp-for-redmine": {
"command": "npx",
"args": ["-y", "@chspower1/mcp-for-redmine@latest"],
"env": {
"REDMINE_BASE_URL": "https://your.redmine.tld",
"REDMINE_API_KEY": "your_api_key_here"
}
}
}
}
```
Claude Desktop
Config files:
- Windows: `%APPDATA%\Claude\claude_desktop_config.json`
- macOS: `~/Library/Application Support/Claude/claude_desktop_config.json`
📚 Docs: [Claude Desktop MCP guide](https://support.anthropic.com/en/articles/10949351-getting-started-with-local-mcp-servers-on-claude-desktop)
```json
{
"mcpServers": {
"mcp-for-redmine": {
"command": "npx",
"args": ["-y", "@chspower1/mcp-for-redmine@latest"],
"env": {
"REDMINE_BASE_URL": "https://your.redmine.tld",
"REDMINE_API_KEY": "your_api_key_here"
}
}
}
}
```
Claude Code
📚 Docs: [Claude Code MCP documentation](https://docs.anthropic.com/en/docs/claude-code/mcp)
Set environment variables and run CLI:
```bash
# Set environment variables
export REDMINE_BASE_URL=https://your.redmine.tld
export REDMINE_API_KEY=your_api_key_here
# Add MCP server
claude mcp add mcp-for-redmine -- npx -y @chspower1/mcp-for-redmine@latest
```
Or edit the settings file directly: `~/.claude/settings.local.json`
```json
{
"mcpServers": {
"mcp-for-redmine": {
"command": "npx",
"args": ["-y", "@chspower1/mcp-for-redmine@latest"],
"env": {
"REDMINE_BASE_URL": "https://your.redmine.tld",
"REDMINE_API_KEY": "your_api_key_here"
}
}
}
}
```
Gemini CLI
Config file: `~/.gemini/settings.json` (global) or `.gemini/settings.json` (per-project)
📚 Docs: [Gemini CLI MCP guide](https://gemini-cli.xyz/docs/en/tools/mcp-server)
```json
{
"mcpServers": {
"mcp-for-redmine": {
"command": "npx",
"args": ["-y", "@chspower1/mcp-for-redmine@latest"],
"env": {
"REDMINE_BASE_URL": "https://your.redmine.tld",
"REDMINE_API_KEY": "your_api_key_here"
}
}
}
}
```
OpenAI Codex
Config file: `~/.codex/config.toml`
📚 Docs: [OpenAI MCP documentation](https://platform.openai.com/docs/mcp)
```toml
[[mcp_servers]]
name = "mcp-for-redmine"
command = "npx"
args = ["-y", "@chspower1/mcp-for-redmine@latest"]
[mcp_servers.env]
REDMINE_BASE_URL = "https://your.redmine.tld"
REDMINE_API_KEY = "your_api_key_here"
```
## Configuration Options
The server reads configuration in the following priority:
CLI flags (highest priority)
- `-u, --url `
- `-k, --api-key `
- `--no-tls-verify` (optional, disable TLS verification)
- ```json
{
"mcpServers": {
"mcp-for-redmine": {
"command": "npx",
"args": [
"-y",
"@chspower1/mcp-for-redmine@latest",
"--url",
"https://your.redmine.tld",
"--api-key",
"YOUR_API_KEY"
]
}
}
}
```
Environment variables
- `REDMINE_BASE_URL` or `REDMINE_URL`
- `REDMINE_API_KEY` or `REDMINE_TOKEN`
- `REDMINE_TLS_VERIFY` (optional, set to `false` or `0` to disable TLS verification)
- ```json
{
"mcpServers": {
"mcp-for-redmine": {
"command": "npx",
"args": ["-y", "@chspower1/mcp-for-redmine@latest"],
"env": {
"REDMINE_BASE_URL": "https://your.redmine.tld",
"REDMINE_API_KEY": "your_api_key_here"
}
}
}
}
```
.env file values
Supported variables:
- `REDMINE_BASE_URL` or `REDMINE_URL` — Redmine server URL
- `REDMINE_API_KEY` or `REDMINE_TOKEN` — Redmine API key
- `REDMINE_TLS_VERIFY` — Set to `false` or `0` to disable TLS verification (optional)
