关键词

Redmine项目管理任务跟踪AI助手ClaudeMCPAPI集成

使用说明

项目简介

MCP Redmine 是一个 MCP 服务器实现，旨在将 Anthropic 的 Claude Desktop (或任何兼容 MCP 协议的客户端) 连接到 Redmine 项目管理系统。通过 MCP Redmine 提供的工具，用户可以使用自然语言指令，让 Claude 助手直接与 Redmine 实例交互，完成诸如创建、查询、更新 Redmine 中的 issue、管理时间记录、上传下载附件等任务。

主要功能点

  • Redmine API 访问: 提供对 Redmine API 的通用访问能力，几乎可以执行 Redmine API 规范中定义的所有操作。
  • 问题 (Issue) 管理: 支持创建、搜索、浏览和更新 Redmine 中的 issue，包括标题、描述、状态、优先级、指派人等字段，并支持 Markdown 格式的内容。
  • 项目 (Project) 管理: 支持搜索和浏览 Redmine 中的项目信息。
  • 附件 (Attachment) 管理: 支持上传文件到 Redmine issue 或项目，以及下载 Redmine 中的附件到本地。
  • 时间记录 (Time Entry) 管理: 支持创建和管理 Redmine 中的时间记录。
  • 灵活的 API 路径操作: 允许用户通过指定 API 路径和 HTTP 方法，直接调用 Redmine API，实现高度定制化的操作。
  • OpenAPI 规范支持: 基于 Redmine OpenAPI 规范构建，确保 API 接口的全面性和准确性。

安装步骤

  1. 克隆仓库:

    git clone https://github.com/runekaagaard/mcp-redmine.git
cd mcp-redmine

  2. 安装 uv (如果尚未安装):

    curl -LsSf https://astral.sh/uv/install.sh | sh

    'uv' 是一个快速的 Python 包安装和运行工具，仓库推荐使用它来运行服务器。您也可以使用 'venv' 或其他 Python 虚拟环境工具。

  3. 配置 Claude Desktop (或 MCP 客户端): 编辑 Claude Desktop 的配置文件 'claude_desktop_config.json' (通常位于用户配置目录下，例如 '~/.config/claude-desktop/claude_desktop_config.json')，添加如下 'mcpServers' 配置。

服务器配置 (claude_desktop_config.json)

{
  "mcpServers": {
    "redmine": {  //  服务器名称，可以自定义，Claude Desktop 中使用此名称引用
      "command": "uv",  //  启动服务器的命令，这里使用 uv
      "args": ["--directory", "/path/to/mcp-redmine", "run", "server.py"], // 启动参数，--directory 指定仓库路径，run server.py 运行服务器脚本
      "env": {  //  环境变量配置
        "REDMINE_URL": "https://your-redmine-instance.example.com",  //  替换为您的 Redmine 实例 URL
        "REDMINE_API_KEY": "your-api-key",   //  替换为您的 Redmine API 密钥
        "REDMINE_REQUEST_INSTRUCTIONS": "/path/to/instructions.md" // (可选) 包含 redmine_request 工具额外说明的 Markdown 文件路径
      }
    }
  }
}

请务必替换以下占位符：

  • '/path/to/mcp-redmine'：替换为您克隆的 'mcp-redmine' 仓库的绝对路径。
  • 'https://your-redmine-instance.example.com'：替换为您的 Redmine 实例的 URL 地址，例如 'https://redmine.example.com'。
  • 'your-api-key'：替换为您 Redmine 账户的 API 密钥。您可以在 Redmine 网站 "我的账户" 页面右侧的 "API 访问密钥" 部分找到或生成。
  • '/path/to/instructions.md' (可选)：如果需要为 'redmine_request' 工具提供额外的使用说明，请创建一个 Markdown 文件并替换为该文件的绝对路径。如果不需要，可以删除此行或留空。

基本使用方法

配置完成后，启动 Claude Desktop。您应该能够在 Claude 中通过 '@redmine' 或您在 'claude_desktop_config.json' 中配置的服务器名称来调用 MCP Redmine 服务器提供的工具。

例如，在 Claude 中您可以这样提问：

  • '@redmine 创建一个新的 issue 在 "网站" 项目中，标题是 "移动设备首页加载缓慢"，描述是 "在 iOS 和 Android 设备上访问首页时，加载指示器出现但内容无法加载。这个问题在上次部署后开始出现。", 优先级是 "高"，指派给 "John Smith"'
  • '@redmine 搜索 "网站" 项目中所有 "高" 优先级的未指派 issue'
  • '@redmine 更新 issue #123 状态为 "进行中"，并添加评论 "我已经开始处理这个问题。预计周五完成。"'
  • '@redmine 记录今天 3.5 小时到 issue #456，工作内容是 "实现用户身份验证"'

请参考仓库 README.md 中的 "Examples" 部分获取更多使用示例。

信息

分类

生产力应用

访问项目