Yonaka15 MCP Server Redmine

🚀 Redmine MCP Server

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

✨ Features

Supports stable resources of the Redmine REST API:

• Issues (1.0~)
• Projects (1.0~)
• Users (1.1~)
• Time entries (1.1~)

Tools

Issues

• Search for issues
  • Filter by project, status, assignee, etc.
  • Keyword search
  • Support for custom fields
• Create/Update issues
  • Set tracker, status, priority
  • Configure custom fields
  • Add comments
• Delete issues

Projects

• Search for projects
  • Filter by active/archived/closed status
  • Keyword search
• Get project details
  • Includes tracker and category information
• Create/Update projects
  • Configure modules and trackers
  • Set member inheritance
• Archive/Unarchive projects
• Delete projects

Time Entries

• Search for time entries
  • Filter by project, user, date range
• Get time entry details
• Create/Update time entries
  • Allocate time by project or user
• Delete time entries

💻 Usage Examples

Basic Usage

Here is an example of integrating with Redmine using this server:

{
  "command": "npx",
  "args": [
    "redmine-mcp-server"
  ],
  "env": {
    "REDMIN_KEY": "your_api_key_here",
    "REDMIN_URL": "https://your-redmine-instance.com"
  }
}

📚 Documentation

Configuration Options

Environment Variables

• REDMIN_KEY: Required. Redmine's API key.
• REDMIN_URL: Optional, default is http://localhost:3000. The URL of the Redmine instance.

📦 Installation

Setup Steps

1. Install dependencies:

npm install

2. Build the project:

npm run build

3. Start the development server:

npm run dev

4. Configure environment variables and run:

REDMIN_KEY=your_api_key REDMIN_URL=https://your-redmine-instance.com node dist/index.js

🧪 Testing

Unit Testing

Run the following command for unit testing:

npm test

Inspector Testing

Test using the MCP Inspector:

mcp-inspect .

⚠️ Important Note

• Creating/Updating/Deleting issues requires administrator privileges.
• Creating/Updating/Deleting projects requires administrator privileges.
• Creating/Updating/Deleting time entries requires administrator or project manager privileges.

Please refer to the Redmine documentation for more information.

🔧 Technical Details

Dependencies

• Node.js: v14+
• npm: v6+

Build Commands

npm install
npm run build

Directory Structure

src/
docs/
package.json
tsconfig.json
README.md

📄 License

MIT

Related Projects

• Model Context Protocol
• MCP TypeScript SDK
• Redmine