Redmine

🚀 Redmine MCP Server for Cline

A custom MCP (Model Context Protocol) server integrated with Redmine, allowing you to interact with your Redmine projects and issues through the Cline VS Code extension.

🚀 Quick Start

This Redmine MCP server enables seamless interaction with Redmine projects and issues via the Cline VS Code extension. Before you start, make sure you meet the prerequisites and follow the installation and configuration steps.

✨ Features

• Integrate with Redmine, enabling interaction with projects and issues.
• Customize MCP server settings to meet your specific needs.
• Provide a range of resource URIs and tool configurations for easy access and operation.

📦 Installation

Prerequisites

• Node.js: You need to have Node.js (version 18 or higher) installed.
• Redmine Instance: You need a running Redmine instance with the REST API enabled.
• Redmine API Key: You need to obtain an API key for your Redmine user account. You can find it in your Redmine account settings (usually under "My Account" -> "API Access Key").
• Cline: You need to install and configure the Cline VS Code extension.

Steps

1. Clone the repository:

   git clone https://github.com/ilask/Redmine-MCP.git
   cd Redmine-MCP
   

2. Install dependencies:

   npm install
   

🔧 Configuration

1. Set environment variables: Create a .env file in the project root directory and add the following content, replacing the placeholders with your actual Redmine hostname and API key:

   REDMINE_HOST=your-redmine-host.com
   REDMINE_API_KEY=your-redmine-api-key
   

   Note: Do not commit the .env file to version control! It contains sensitive information. The .gitignore file included in this repository prevents it from being committed.

💻 Usage Examples

Add to Cline

1. Open Cline settings: In VS Code, open the Cline extension and go to the MCP Servers tab.
2. Edit MCP settings: Click "Edit MCP Settings" to open the cline_mcp_settings.json file.
3. Add the server: Add the following entry to the mcpServers object, replacing the placeholder in args with the absolute path:

   {
     "mcpServers": {
       "redmine-server": {
         "command": "node",
         "args": ["C:\\Users\\yourusername\\path\\to\\Redmine-MCP\\server.js"],
         "disabled": false,
         "autoApprove": []
       }
     }
   }
   

   Note: Make sure to use double backslashes (\\) on Windows.
4. Save: Save the cline_mcp_settings.json file. Cline should automatically detect the changes and start the server.

Resources and Tools

Resources

• Projects: Access projects using the following URIs:

  redmine://projects
  redmine://projects/{project_id}
  

Tools

• Create an issue: Use the following JSON configuration to create an issue in a project:

  {
    "subject": "Issue subject",
    "description": "Issue description"
  }
  

📚 Documentation

Troubleshooting

• Connection closed error: Ensure that the REST API of your Redmine instance is enabled and your API key is correct.
• Check server logs: If you encounter issues, check the MCP server's log file for more information.

We hope this guide helps you use the Redmine MCP server!