MCP Redmine

状态：运行良好，日常使用中，未发现任何已知错误。

让 Claude 成为你的 Redmine 助手！ MCP Redmine 将 Claude Desktop 连接到你的 Redmine 实例，使其能够：

• 搜索和浏览项目和问题
• 创建和更新问题，完全支持 Markdown 格式
• 上传和下载文件附件
• 管理和跟踪时间记录
• 更新问题状态和字段
• 访问全面的 Redmine API 功能

使用 httpx 进行 API 请求，并与 Redmine OpenAPI 规范集成，以实现全面的 API 覆盖。

要求

• 访问 Redmine 实例
• Redmine API 密钥
• Python 3.10+

使用的 OpenAPI 规范适用于 Redmine 5.0，已在 Redmine 6.0.3 上测试，但也可能适用于旧版本。

API

工具

• redmine_paths_list

  • 从 OpenAPI 规范返回可用 API 路径的列表
  • 无需输入
  • 返回包含路径模板列表的 YAML 字符串：

  - /issues.json
  - /projects.json
  - /time_entries.json
  ...
  

• redmine_paths_info

  • 获取给定路径模板的完整路径信息
  • 输入：path_templates (字符串列表)
  • 返回包含所请求路径的 API 规范的 YAML 字符串：

  /issues.json:
    get:
      operationId: getIssues
      parameters:
        - $ref: '#/components/parameters/format'
      ...
  

• redmine_request

  • 向 Redmine API 发出请求
  • 输入：
    • path (字符串)：API 端点路径 (例如 '/issues.json')
    • method (字符串，可选)：要使用的 HTTP 方法 (默认：'get')
    • data (对象，可选)：请求正文的字典 (用于 POST/PUT)
    • params (对象，可选)：查询参数的字典
  • 返回包含响应状态代码、正文和错误消息的 YAML 字符串：

  status_code: 200
  body:
    issues:
      - id: 1
        subject: "Fix login page"
        ...
  error: ""
  

• redmine_upload

  • 将文件上传到 Redmine 并获取附件的令牌
  • 输入：
    • file_path (字符串)：要上传的文件的完整路径
    • description (字符串，可选)：文件的可选描述
  • 返回与 redmine_request 格式相同的 YAML 字符串，包括上传令牌：

  status_code: 201
  body:
    upload:
      id: 7
      token: "7.ed32257a2ab0f7526c0d72c32994c58b131bb2c0775f7aa84aae01ea8397ea54"
  error: ""
  

• redmine_download

  • 从 Redmine 下载附件并将其保存到本地文件
  • 输入：
    • attachment_id (整数)：要下载的附件的 ID
    • save_path (字符串)：应保存文件的完整路径
    • filename (字符串，可选)：要使用的可选文件名 (如果未提供，则自动确定)
  • 返回包含下载结果的 YAML 字符串：

  status_code: 200
  body:
    saved_to: "/path/to/downloaded/file.pdf"
    filename: "file.pdf"
  error: ""
  

与 Claude Desktop 一起使用

添加到你的 claude_desktop_config.json：

{
  "mcpServers": {
    "redmine": {
      "command": "uv",
      "args": ["--directory", "/path/to/mcp-redmine", "run", "server.py"],
      "env": {
        "REDMINE_URL": "https://your-redmine-instance.example.com",
        "REDMINE_API_KEY": "your-api-key",
        "REDMINE_REQUEST_INSTRUCTIONS": "/path/to/instructions.md"
      }
    }
  }
}

环境变量：

• REDMINE_URL：你的 Redmine 实例的 URL (必需)
• REDMINE_API_KEY：你的 Redmine API 密钥 (必需，请参阅下文了解如何获取)
• REDMINE_REQUEST_INSTRUCTIONS：包含 redmine_request 工具的其他说明的文件的路径 (可选)

获取你的 Redmine API 密钥

1. 登录到你的 Redmine 实例
2. 转到“我的帐户”（通常位于右上角菜单中）
3. 在页面右侧，你应该看到“API 访问密钥”
4. 单击“显示”以查看你现有的密钥，或单击“生成”以创建一个新密钥
5. 复制此密钥以在你的配置中使用

安装

1. 克隆存储库：

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

2. 确保你已安装 uv

# 如果你尚未安装 uv，请安装它
curl -LsSf https://astral.sh/uv/install.sh | sh

3. 将 Redmine 配置添加到 claude_desktop_config.json (见上文)

示例

创建新问题

让我们在“网站”项目中创建一个新的错误报告：

1. 标题：“主页未在移动设备上加载”
2. 描述：“从 iOS 或 Android 设备访问主页时，会出现加载微调器，但内容永远不会加载。此问题在上次部署后开始出现。”
3. 优先级：高
4. 分配给：John Smith

搜索问题

你能找到“网站”项目中所有当前未分配的高优先级问题吗？

更新问题状态

请将问题 #123 标记为“进行中”并添加评论：“我已经开始处理这个问题。预计将在周五完成。”

记录时间

记录今天针对问题 #456 完成的“实施用户身份验证”的 3.5 小时。

贡献

热烈欢迎贡献！无论是错误报告、功能请求、文档改进还是代码贡献 - 所有输入都很有价值。请随意：

• 打开一个 issue 来报告错误或建议功能
• 提交包含改进的 pull request
• 增强文档或分享你的使用示例
• 提出问题并分享你的经验

目标是使 Claude 的 Redmine 项目管理更加出色，你的见解和贡献有助于实现这一目标。

致谢

该项目建立在他人出色的工作之上：

• httpx - 用于处理 HTTP 请求
• Redmine OpenAPI Specification - 用于全面的 API 规范
• Redmine - 灵活的项目管理 Web 应用程序

许可证

Mozilla Public License Version 2.0