Redmine MCP Server For Cline

🚀 Redmine MCP Server (for Cline)

This is 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

Prerequisites

• Node.js: You need to have Node.js (version 18 or higher) installed on your system.
• 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 have the Cline VS Code extension installed and configured.

Installation

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
   

   ⚠️ Important 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.

Adding 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 path in args with the absolute path to the actual server.js file:

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

   ⚠️ Important 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.

✨ Features

Available Resources and Tools

Resources

• redmine://projects/{project_id}: This resource represents a Redmine project. Replace {project_id} with the actual project ID in your Redmine instance. You can read the project details using Cline's access_mcp_resource tool. For example:

  <access_mcp_resource>
  <server_name>redmine-server</server_name>
  <uri>redmine://projects/123</uri>
  </access_mcp_resource>
  

  (Replace 123 with a valid project ID). This will return the project details as JSON.

Tools

• create_issue: This tool allows you to create new issues in Redmine. It accepts the following parameters:

  • title (required): The title of the issue.
  • description (optional): The description of the issue.
  • project_id (optional): The ID of the project.

  Example:

  POST http://localhost:3000/api/mcp
  Content-Type: application/json
  
  {
    "command": "create_issue",
    "params": {
      "title": "This is a test issue",
      "description": "This is the description of the issue.",
      "project_id": "123"
    }
  }
  

📚 Documentation

Troubleshooting

• Check Node.js Version: Ensure you are using a compatible version (Node.js 18 or higher).
• View Logs: If there are issues, check the server's console output for more information.
• Reload Cline Settings: After adding or modifying the configuration, make sure to reload the Cline extension to apply the changes.

With this, you can easily integrate Redmine into your project and leverage Cline for efficient development and management.