Mcp For Redmine

by chspower1

270 downloads Not rated yet
GitHub

About

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.

Explore

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.

Setting up with Highlight

This MCP is not yet compatible with Highlight’s one-click setup. However, you can still use it with Highlight by following these steps:

  1. Download and install Highlight from highlightai.com/download
  2. Navigate to the plugins tab and select "Add Custom Plugin"
  3. Configure the plugin with the settings below
    Plugin Name Mcp For Redmine
    Command (node, npx, python, etc.)

    Please refer to the README for specific instructions on how to obtain API keys or other required environment variables.

  4. Enable "Start Automatically" if you want the plugin to start when Highlight launches

From the repository

- Node.js 18 or higher
- Redmine API key (your personal API key from your Redmine account)

Compatibility baseline: Redmine 6.0.6

export REDMINE_BASE_URL=https://your.redmine.tld
export REDMINE_API_KEY=your_api_key_here

The server reads configuration in the following priority:

<details>
<summary><b>CLI flags (highest priority)</b></summary>

- -u, --url <url>
- -k, --api-key <key>
-

  {
"mcpServers": {
"mcp-for-redmine": {
"command": "npx",
"args": [
"-y",
"@chspower1/mcp-for-redmine@latest",
"--url",
"https://your.redmine.tld",
"--api-key",
"YOUR_API_KEY"
]
}
}
}

</details>

<details><summary><b>Environment variables</b></summary>

- REDMINE_BASE_URL or REDMINE_URL
- REDMINE_API_KEY or REDMINE_TOKEN
-

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

</details>

<details><summary><b>.env file values</b></summary>

<b>Supported variables:</b>

- REDMINE_BASE_URL or REDMINE_URL — Redmine server URL
- REDMINE_API_KEY or REDMINE_TOKEN — Redmine API key
</details>

Claude Desktop / Cursor

Paste into your MCP client config file to install this server.

{
    "mcpServers": {
        "mcp for redmine": {
            "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"
        }
    }
}

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:

<details>
<summary><b>Cursor</b></summary>

File (top-left) -> Preferences -> Cursor Settings -> MCP & Integrations -> New MCP Server

<b>Config file</b>: ~/.cursor/mcp.json (global) or .cursor/mcp.json (per-project)

📚 <b>Docs</b>: Cursor MCP documentation

Install MCP Server

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

</details>

<details>
<summary><b>Claude Desktop</b></summary>

<b>Config files</b>:

- <b>Windows</b>: %APPDATA%\Claude\claude_desktop_config.json
- <b>macOS</b>: ~/Library/Application Support/Claude/claude_desktop_config.json

📚 <b>Docs</b>: Claude Desktop MCP guide

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

</details>

<details>
<summary><b>Claude Code</b></summary>

📚 <b>Docs</b>: Claude Code MCP documentation

<b>Set environment variables and run CLI</b>:

```bash

No reviews yet — be the first

Sign in to leave a review

Use Google, GitHub, or an email account so ratings stay tied to real people.

Email sign in

No reviews posted yet.