使用说明

项目简介

Redmine Integration Server 是一个基于 Model Context Protocol (MCP) 构建的服务器,旨在将 Redmine 项目管理系统与支持 MCP 协议的客户端(如 Cline VS Code 扩展)连接起来。通过该服务器,用户可以使用 Cline 等工具,以标准化的方式访问 Redmine 中的项目信息,并执行创建 Issue 等操作。

主要功能点

  • 资源访问: 提供对 Redmine 项目信息的读取能力,允许客户端通过 'redmine://projects/{project_id}' 格式的 URI 获取项目详情。
  • 工具调用: 支持 'create_issue' 工具,允许客户端在指定的 Redmine 项目中创建新的 Issue。
  • 标准 MCP 协议: 基于 MCP 协议开发,确保与 MCP 客户端的兼容性和互操作性。

安装步骤

  1. 克隆仓库:
    git clone https://github.com/ilask/Redmine-MCP.git
  2. 进入目录:
    cd Redmine-MCP
  3. 安装依赖:
    npm install
  4. 配置环境变量: 在项目根目录下创建 '.env' 文件,并填入您的 Redmine 主机地址和 API Key:
    REDMINE_HOST=your-redmine-host.com
    REDMINE_API_KEY=your-redmine-api-key

服务器配置

为了让 MCP 客户端 (如 Cline) 连接到 Redmine MCP 服务器,您需要在客户端的 MCP 设置中添加以下服务器配置。请注意将 'args' 中的路径替换为 'server.js' 文件的绝对路径

{
  "mcpServers": {
    "redmine-server": {
      "command": "node",
      "args": ["/path/to/Redmine-MCP/server.js"],  //  请替换为 server.js 文件的绝对路径,例如 "C:\\Users\\yourusername\\path\\to\\Redmine-MCP\\server.js" (Windows) 或 "/home/yourusername/path/to/Redmine-MCP/server.js" (Linux/macOS)
      "disabled": false,
      "autoApprove": []
    }
  }
}

基本使用方法

  • 启动服务器后,在 Cline 中可以使用 '<access_mcp_resource>' 标签访问 Redmine 项目资源,例如:
    <access_mcp_resource>
      <server_name>redmine-server</server_name>
      <uri>redmine://projects/123</uri>
    </access_mcp_resource>
  • 使用 '<use_mcp_tool>' 标签调用 'create_issue' 工具创建 Issue,例如:
    <use_mcp_tool>
      <server_name>redmine-server</server_name>
      <tool_name>create_issue</tool_name>
      <arguments>
        {
          "project_id": "456",
          "subject": "My New Issue",
          "description": "This is a test issue created via Cline."
        }
      </arguments>
    </use_mcp_tool>

信息

分类

开发者工具