使用说明

项目简介

Redmine MCP Server 是一个基于 Model Context Protocol (MCP) 构建的应用后端,它充当 Claude AI 或其他 MCP 客户端与 Redmine 项目管理系统之间的桥梁。通过此服务器,Claude 能够以标准化的方式访问和操作 Redmine 中的项目、问题、Wiki 等资源,并执行预定义的操作工具,从而实现更智能化的项目管理和人机协作。

主要功能点

  • Redmine 项目管理集成: 支持列出、查看 Redmine 项目的详细信息,方便 Claude 了解项目概况。
  • Redmine 问题跟踪: 允许 Claude 创建、更新、列出和查看 Redmine 中的问题(Issue),包括完整参数支持和父子任务关系管理。
  • Redmine 议题关系管理: 支持创建、查看和管理议题之间的各种关系,例如关联、阻止等。
  • 用户信息访问: 允许 Claude 获取当前 Redmine 用户的信息和权限。
  • Mock 模式: 提供 Mock 模式,无需真实 Redmine 实例即可进行开发、测试和演示。
  • 详细错误处理: 提供详细的错误报告和参数验证,方便问题排查。

安装步骤

  1. 克隆仓库:
    git clone https://github.com/zacharyelston/RedmineMCP.git
    cd RedmineMCP
  2. 配置环境变量: 在 'redmcp-typescript/' 目录下创建 '.env' 文件,并参照 '.env.example' 填写 Redmine API 密钥和 Redmine 服务器 URL。
    REDMINE_URL=http://your-redmine-instance.com
    REDMINE_API_KEY=your-api-key-here
    LOG_LEVEL=info
  3. 安装依赖:
    cd redmcp-typescript/
    npm install
  4. 构建项目:
    npm run build
  5. 启动服务器:
    npm start

服务器配置

要将 Redmine MCP 服务器配置到 MCP 客户端(如 Claude Desktop),您需要提供服务器的启动命令和参数。以下是 'claude_desktop_config.json' 文件的配置示例,请根据实际路径进行调整:

{
  "mcpServers": {
    "redmine": {
      "command": "node",
      "args": ["/absolute/path/to/RedmineMCP/redmcp-typescript/build/index.js"],
      "env": {
        "REDMINE_URL": "http://your-redmine-instance.com",
        "REDMINE_API_KEY": "your-api-key-here",
        "LOG_LEVEL": "info"
      }
    }
  }
}

配置参数说明:

  • 'server name': 'redmine' (服务器名称,可自定义)
  • 'command': 'node' (Node.js 运行命令)
  • 'args': '["/absolute/path/to/RedmineMCP/redmcp-typescript/build/index.js"]' (服务器启动脚本的绝对路径,请替换为实际路径)
  • 'env': 环境变量配置
    • 'REDMINE_URL': 您的 Redmine 服务器 URL,例如 'http://your-redmine-instance.com'
    • 'REDMINE_API_KEY': 您的 Redmine API 密钥
    • 'LOG_LEVEL': 日志级别,可选 'info' 或 'debug'

基本使用方法

服务器启动后,MCP 客户端(如 Claude Desktop)即可通过配置连接到 Redmine MCP Server。连接成功后,客户端可以通过 MCP 协议调用服务器提供的各种工具,例如:

  • 使用 'redmine_projects_list' 工具列出 Redmine 项目。
  • 使用 'redmine_issues_get' 工具获取指定 Issue 的详细信息。
  • 使用 'redmine_issues_create' 工具在 Redmine 中创建新的 Issue。

具体工具的使用方法和参数,请参考仓库 'redmcp-typescript/README.md' 中的详细文档。

信息

分类

开发者工具