关键词

Redmine项目管理问题跟踪任务管理知识库

使用说明

项目简介

Redmine MCP Server 是一个基于 Model Context Protocol (MCP) 构建的服务器，旨在桥接 Redmine 项目管理系统和大型语言模型 (LLMs)。它允许 LLMs 通过标准化的 MCP 协议访问和操作 Redmine 中的项目、问题、用户和时间记录等信息，从而增强 LLM 在项目管理和协作方面的能力。

主要功能点

  • 资源访问: 提供 Redmine 项目、问题、用户和时间记录的稳定资源访问接口，使 LLM 能够获取 Redmine 中的关键数据。
  • 工具集成: 注册并执行 Redmine API 提供的各种工具，例如搜索、创建、更新和删除项目、问题、时间记录和用户，赋予 LLM 操作 Redmine 的能力。
  • 数据格式化: 将 Redmine API 返回的数据格式化为 LLMs 易于理解和使用的 XML 格式，方便 LLM 进行后续处理和分析。

安装步骤

  1. 环境准备: 确保已安装 Node.js (版本 18 或更高) 和 npm (版本 9 或更高)。
  2. 克隆仓库: 将 GitHub 仓库克隆到本地： 
    git clone https://github.com/yonaka15/mcp-server-redmine.git
  3. 进入目录: 进入仓库目录： 
    cd mcp-server-redmine
  4. 安装依赖: 安装项目依赖： 
    npm install
  5. 构建项目: 构建项目： 
    npm run build
  6. 设置权限: 设置 'dist/index.js' 文件的执行权限 (重要)： 
    chmod +x dist/index.js
  7. 配置 Redmine 连接: 复制 '.env.example' 文件为 '.env'，并根据您的 Redmine 实例修改 '.env' 文件中的 'REDMINE_HOST' (Redmine 服务器 URL) 和 'REDMINE_API_KEY' (Redmine API 密钥) 环境变量。

服务器配置

MCP 客户端需要配置以下 JSON 格式信息以连接 Redmine MCP Server：

{
  "redmine-mcp-server": {  // server name，自定义，用于MCP客户端识别
    "command": "npx",    // 启动命令，通常为 npx
    "args": [           // 启动参数
      "-y",             // 自动应答 "yes"
      "--prefix",       // 指定安装目录
      "/path/to/mcp-server-redmine", // MCP服务器的安装路径，请替换为实际路径
      "mcp-server-redmine" // npm 包名称
    ],
    "env": {            // 环境变量
      "REDMINE_HOST": "https://your-redmine.example.com", // 您的 Redmine 服务器 URL，请替换为实际URL
      "REDMINE_API_KEY": "your-api-key-here"           // 您的 Redmine API 密钥，请替换为实际密钥
    }
  }
}

基本使用方法

  1. 启动服务器: 在仓库根目录下，运行以下命令启动 MCP 服务器：
    • 开发模式: 'npm run dev' (用于开发和调试)
    • 生产模式: 'npm start' (用于生产环境)
  2. 客户端配置: 将上述服务器配置 JSON 信息添加到您的 MCP 客户端配置中。
  3. 连接与使用: MCP 客户端将通过 MCP 协议与 Redmine MCP Server 建立连接，并可以使用服务器提供的工具和资源与 Redmine 进行交互。

注意: 首次使用前，请确保已在 Redmine 后台启用 REST API 并获取有效的 API 密钥。

信息

分类

开发者工具

访问项目