Redmine MCP Server

by yonaka15

15 452 downloads Not rated yet MIT

About

A Model Context Protocol server for interacting with Redmine using its REST API, enabling the management of tickets, projects, and user data through integration with LLMs.

Details

Repository
yonaka15/mcp-server-redmine
License
MIT

Explore

Supports stable resources from Redmine REST API:

- Issues (1.0~)
- Projects (1.0~)
- Users (1.1~)
- Time Entries (1.1~)

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 Redmine MCP Server
    Command (node, npx, python, etc.) npx
    Arguments
    • Argument 1 -y
    • Argument 2 --prefix
    • Argument 3 /path/to/mcp-server-redmine
    • Argument 4 mcp-server-redmine
    Environment
    • REDMINE_HOST https://your-redmine.example.com
    • REDMINE_API_KEY your-api-key-here

    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
- npm 9 or higher

To use this server with Claude, configure it as follows:

{
  "mcp-server-redmine": {
    "command": "npx",
    "args": [
      "-y",
      "--prefix",
      "/path/to/mcp-server-redmine",
      "mcp-server-redmine"
    ],
    "env": {
      "REDMINE_HOST": "https://your-redmine.example.com",
      "REDMINE_API_KEY": "your-api-key-here"
    }
  }
}

- command: Command to execute the npm package
- args:
- -y: Auto-respond "yes" to prompts
- --prefix: Specify installation directory
- Last argument specifies the package name
- env: Environment variables
- REDMINE_HOST: Redmine server URL
- REDMINE_API_KEY: Your Redmine API key

1. Enable REST API in Redmine admin settings
2. Get API key from user settings page

Set the following environment variables:

- REDMINE_API_KEY: API key obtained from Redmine user settings
- REDMINE_HOST: Redmine server URL (e.g., https://redmine.example.com)

export REDMINE_API_KEY=your-api-key-here
export REDMINE_HOST=http://localhost:3000 # or your Redmine server URL


Basic Testing Commands:

1. List available tools:

bash
npx @modelcontextprotocol/inspector --cli \
-e REDMINE_API_KEY=$REDMINE_API_KEY \
-e REDMINE_HOST=$REDMINE_HOST \
node dist/index.js \
--method tools/list

2. Test Issues functionality:

bash

npm install

Search Issues

Filter issues by project, status, assignee, and perform keyword searches. Supports custom fields.

Create/Update Issues

Set tracker, status, and priority for issues. Configure custom fields and add comments.

Delete Issues

Remove issues from the system.

Search Projects

Filter projects by active, archived, or closed status. Supports keyword searches.

Get Project Details

Retrieve details about a specific project, including trackers and categories information.

Create/Update Projects

Configure modules and trackers for projects and set member inheritance.

Archive/Unarchive Projects

Change the status of projects to archived or unarchived.

Delete Projects

Remove projects from the system.

Search Time Entries

Filter time entries by project, user, or date range.

Get Time Entry Details

Retrieve details about a specific time entry.

Create/Update Time Entries

Record time entries against projects or issues, specify activity, and support custom fields.

Delete Time Entries

Remove time entries from the system.

Issues

- Search Issues
- Filter by project, status, assignee, etc.
- Keyword search
- Custom field support
- Create/Update Issues
- Set tracker, status, priority
- Configure custom fields
- Add comments
- Delete Issues

Projects

- Search Projects
- Filter by active/archived/closed status
- Keyword search
- Get Project Details
- Include trackers, categories information
- Create/Update Projects
- Configure modules and trackers
- Set member inheritance
- Archive/Unarchive Projects
- Delete Projects

Time Entries

- Search Time Entries
- Filter by project, user, date range
- Get Time Entry Details
- Create/Update Time Entries
- Record against project or issue
- Specify activity
- Custom field support
- Delete Time Entries

Claude Desktop / Cursor

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

{
    "mcpServers": {
        "redmine mcp server": {
            "env": {
                "REDMINE_HOST": "https://your-redmine.example.com",
                "REDMINE_API_KEY": "your-api-key-here"
            },
            "args": [
                "-y",
                "--prefix",
                "/path/to/mcp-server-redmine",
                "mcp-server-redmine"
            ],
            "command": "npx"
        }
    }
}

Linux

{
    "env": {
        "REDMINE_HOST": "https://your-redmine.example.com",
        "REDMINE_API_KEY": "your-api-key-here"
    },
    "args": [
        "-y",
        "--prefix",
        "/path/to/mcp-server-redmine",
        "mcp-server-redmine"
    ],
    "command": "npx"
}

Macos

{
    "env": {
        "REDMINE_HOST": "https://your-redmine.example.com",
        "REDMINE_API_KEY": "your-api-key-here"
    },
    "args": [
        "-y",
        "--prefix",
        "/path/to/mcp-server-redmine",
        "mcp-server-redmine"
    ],
    "command": "npx"
}

Windows

{
    "env": {
        "REDMINE_HOST": "https://your-redmine.example.com",
        "REDMINE_API_KEY": "your-api-key-here"
    },
    "args": [
        "/c",
        "npx",
        "-y",
        "--prefix",
        "/path/to/mcp-server-redmine",
        "mcp-server-redmine"
    ],
    "command": "cmd"
}

smithery badge

This is a Model Context Protocol (MCP) server implementation for Redmine. It integrates with Redmine's REST API to provide ticket and project information to LLMs.

<a href="https://glama.ai/mcp/servers/55eg9u36cg">Redmine Server MCP server</a>

Features

Supports stable resources from Redmine REST API:

- Issues (1.0~)
- Projects (1.0~)
- Users (1.1~)
- Time Entries (1.1~)

Tools

Issues

- Search Issues
- Filter by project, status, assignee, etc.
- Keyword search
- Custom field support
- Create/Update Issues
- Set tracker, status, priority
- Configure custom fields
- Add comments
- Delete Issues

Projects

- Search Projects
- Filter by active/archived/closed status
- Keyword search
- Get Project Details
- Include trackers, categories information
- Create/Update Projects
- Configure modules and trackers
- Set member inheritance
- Archive/Unarchive Projects
- Delete Projects

Time Entries

- Search Time Entries
- Filter by project, user, date range
- Get Time Entry Details
- Create/Update Time Entries
- Record against project or issue
- Specify activity
- Custom field support
- Delete Time Entries

Usage with Claude

To use this server with Claude, configure it as follows:

{
  "mcp-server-redmine": {
    "command": "npx",
    "args": [
      "-y",
      "--prefix",
      "/path/to/mcp-server-redmine",
      "mcp-server-redmine"
    ],
    "env": {
      "REDMINE_HOST": "https://your-redmine.example.com",
      "REDMINE_API_KEY": "your-api-key-here"
    }
  }
}

Configuration Options

- command: Command to execute the npm package
- args:
- -y: Auto-respond "yes" to prompts
- --prefix: Specify installation directory
- Last argument specifies the package name
- env: Environment variables
- REDMINE_HOST: Redmine server URL
- REDMINE_API_KEY: Your Redmine API key

Setup

Getting an API Key

1. Enable REST API in Redmine admin settings
2. Get API key from user settings page

Environment Variables

Set the following environment variables:

- REDMINE_API_KEY: API key obtained from Redmine user settings
- REDMINE_HOST: Redmine server URL (e.g., https://redmine.example.com)

Testing

Unit Tests

```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.