MCP-For-Redmine ·

English | 한국어 | 日本語 | 简体中文

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:

{
  "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"
      }
    }
  }
}

{
  "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"
      }
    }
  }
}

# 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

{
  "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"
      }
    }
  }
}

{
  "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"
      }
    }
  }
}

[[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:

Key Features

Currently available tools:

Stable API

• Users: users_create, users_get, users_current, users_list, users_update, users_delete
• Projects: projects_list, projects_get, projects_create, projects_update, projects_archive, projects_unarchive, projects_delete
• Issues: issues_list, issues_get, issues_create, issues_update, issues_delete
• Time Entries: time_entries_list, time_entries_get, time_entries_create, time_entries_update, time_entries_delete

Alpha API

• Enumerations: enumerations_issue_priorities_list, enumerations_time_entry_activities_list
• Memberships: memberships_list_project_memberships, memberships_get, memberships_create, memberships_update, memberships_delete
• Issue Relations: issue_relations_list, issue_relations_get, issue_relations_create, issue_relations_delete
• Versions: versions_list, versions_get, versions_create, versions_update, versions_delete
• Wiki Pages: wiki_pages_list, wiki_pages_get, wiki_pages_create_or_update, wiki_pages_delete
• Queries: queries_list
• Files: files_list
• Attachments: attachments_get, attachments_delete, attachments_upload
• Issue Statuses: issue_statuses_list
• Trackers: trackers_list
• Roles: roles_list, roles_get
• Groups: groups_list, groups_get, groups_create, groups_update, groups_delete, groups_add_user, groups_remove_user
• Custom Fields: custom_fields_list
• Issue Categories: issue_categories_list, issue_categories_get, issue_categories_create, issue_categories_update, issue_categories_delete
• My Account: my_account_get
• Search: search

The input schema for each tool is defined in src/schema/*.schema.ts. Results are returned as JSON-formatted text.

Common Input Rules (dev)

• Collection pagination: most list tools support offset and limit (default 25, max 100)
• Association expansion: some get/list tools support include (e.g., issues: children,attachments,journals,...)
• Attachment upload token: attachments_upload sends a Base64 file to /uploads.json and returns a token. Use this token in the uploads field of issues_create/update or wiki_pages_create_or_update to associate attachments.
• Tool-specific extras/constraints: for detailed constraints (e.g., issue custom_fields, watcher_user_ids, etc.), see each tool’s schema in src/schema/*.schema.ts.

Troubleshooting Guide

• Configuration errors
  • Example messages: ❌ Redmine URL is required! or ❌ Redmine API key is required!
  • How to fix: Choose one of the configuration methods shown in the error message. For security, environment variables are recommended.
• Node.js/ESM-related errors
  • Ensure you are using Node.js 18 or higher.
• Authentication and network errors (401, 403, etc.)
  • Verify your API key permissions and URL, and check for network issues.
• Execution issues on Windows
  • Try running with cmd /c npx ... as shown in the guide.

Security & Permissions

• API keys are sensitive; avoid exposing them in Git commits, logs, or shared repositories.
• For irreversible actions like deleting projects or issues, double-check permissions and proceed carefully.

Roadmap

We plan to deepen coverage of beta endpoints (e.g., attachment upload flows), add SSE (Server-Sent Events), and enhance examples/tests.

License

MIT