Redmine Integration Server for Cline Extension

This custom Model Context Protocol (MCP) handler establishes connectivity to a Redmine instance, enabling users to manipulate projects and associated work items directly via the Cline VS Code add-on.

Essential Prerequisites

• Node Runtime: Execution requires Node.js, specifically version 18 or a subsequent release.
• Redmine Endpoint: A functional Redmine installation must be operational, with its Service-Oriented Architecture (SOA) interface (REST API) activated.
• Authentication Token: A valid API access credential linked to your Redmine user account is mandatory. This key is typically obtained from the user's profile management section (often under 'My Account' -> 'API access key').
• Cline Component: The Cline extension must be installed within the Visual Studio Code environment.

Deployment Procedure

1. Repository Retrieval: Clone the source code repository: bash git clone https://github.com/ilask/Redmine-MCP.git cd Redmine-MCP

2. Dependency Resolution: Install necessary software packages: bash npm install

Configuration of Environment Variables

1. Credential File Creation: Generate a file named .env in the main project directory. Populate it with your endpoint details, substituting the placeholders:

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

   Security Warning: Ensure this .env file is excluded from source control tracking (e.g., via .gitignore) as it contains sensitive credentials.

Registering with Cline

1. Access Cline Configuration: Navigate to the Cline extension panel in VS Code and select the MCP Server configuration tab.
2. Modify Settings: Choose the option to modify the configuration file (cline_mcp_settings.json).

3. Incorporate Server Entry: Insert the following structural block into the mcpServers object. Crucially, substitute the placeholder path in args with the fully qualified, absolute file system location of server.js:

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

   Note for Windows Users: Path separators must be escaped, using double backslashes (\\). 4. Persistence: Save the configuration file. Cline is designed to auto-detect and initiate the service handler.

Accessible Data Structures and Utility Functions

Data Locators (Resources)

• redmine://projects/{project_id}: This Uniform Resource Identifier (URI) points to a specific Redmine project entity. Substitute {project_id} with the numerical identifier from your Redmine database. Project metadata can be retrieved using Cline's access_mcp_resource utility. Example invocation:

  redmine-server redmine://projects/123

This operation returns the project's attribute set serialized in JSON format.

Operational Tools

• create_issue: A utility designed for provisioning new items (issues) within a Redmine project structure. Required parameters include:

  • project_id (Textual, mandatory): The target project's numerical identifier.
  • subject (Textual, mandatory): The concise title assigned to the new item.
  • description (Textual, mandatory): The detailed narrative explaining the item.

  This tool is invoked via Cline's use_mcp_tool. Example structure:

  redmine-server create_issue { "project_id": "456", "subject": "My New Issue", "description": "This is a test issue created via Cline." }

  Executing this command initiates the creation of the issue in the designated project, subsequently returning the newly created entity's data structure as JSON.

Diagnostic and Resolution Guidance

• Connectivity Failure ("Connection closed"): If the system reports an error akin to "MCP error -1: Connection closed," meticulously verify the configuration of the REDMINE_HOST and REDMINE_API_KEY environment values. Confirm network accessibility to the Redmine server from the host machine.
• Trace Server Output: In situations of ambiguity, examine the output stream displayed in the VS Code integrated terminal. The handler service outputs all relevant operational diagnostics and error reports to this console.