Redmine MCP Server

Redmine MCP 服务

一个模型上下文协议（MCP）服务，可让 AI 助手与 Redmine 交互，实现专注且透明的项目管理。

概述

此 MCP 服务在 AI 助手与 Redmine 之间搭建桥梁，让 AI 能够：

• 创建和更新问题，并进行适当分类
• 管理 Wiki 页面和文档
• 跟踪项目状态和进度
• 遵循既定流程，确保一致性

使用此 MCP 服务，可以确保 AI 工作始终专注、文档完善，并对团队成员完全透明。

功能

资源功能

• 问题：访问 Redmine 问题，并支持筛选和搜索
• 项目：访问项目数据、类别和状态
• Wiki：访问用于文档记录的 Wiki 页面

工具功能

• create_issue：创建并适当分类新问题
• update_issue：更新现有问题，包括状态变更和备注
• create_wiki：创建或更新用于文档记录的 Wiki 页面
• get_project_status：获取项目状态摘要和统计信息

提示词功能

• issue_template：用于创建结构完善的问题的模板
• wiki_template：用于创建结构完善的 Wiki 页面的模板

要求

• Python 3.9+
• Flask
• 可通过 API 访问的 Redmine 实例
• Claude Desktop 或其他兼容 MCP 的 AI 助手

安装

1. 克隆仓库：

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

2. 安装依赖：

   pip install -r requirements.txt
   

3. 配置服务：

   cp config.yaml.example config.yaml
   # Edit config.yaml with your Redmine URL and API key
   

用法

运行服务

使用以下命令启动服务：

python main.py

服务默认运行在端口 5000 上。

Docker 部署

构建并运行 Docker 容器：

docker build -t redmine-mcp-server .
docker run -d -p 5000:5000 -e REDMINE_API_KEY=your_api_key -e REDMINE_URL=http://localhost:3000 redmine-mcp-server

配置 Claude Desktop

将以下内容添加到 Claude Desktop MCP 配置中：

{
  "mcps": {
    "redmine": {
      "command": "docker",
      "args": [
        "run",
        "-i",
        "--rm",
        "-e",
        "REDMINE_API_KEY",
        "-e",
        "REDMINE_URL",
        "redmine-mcp-server:latest"
      ],
      "environment": {
        "REDMINE_API_KEY": "your_redmine_api_key",
        "REDMINE_URL": "http://localhost:3000"
      }
    }
  }
}

API 参考

MCP 端点

• GET /mcp：返回 MCP 功能
• GET /mcp/health：返回健康状态

资源端点

• GET /mcp/resources/issues：以资源形式返回问题
• GET /mcp/resources/projects：返回项目数据
• GET /mcp/resources/wiki：返回 Wiki 页面

工具端点

• POST /mcp/tools/create_issue：创建新问题
• POST /mcp/tools/update_issue：更新现有问题
• POST /mcp/tools/create_wiki：创建或更新 Wiki 页面
• POST /mcp/tools/get_project_status：获取项目状态和统计信息

提示词端点

• GET /mcp/prompts/issue_template：返回用于创建问题的模板
• GET /mcp/prompts/wiki_template：返回用于创建 Wiki 页面的模板

配置选项

可使用 config.yaml 文件或环境变量配置服务：

选项	环境变量	说明	默认值
redmine_url	REDMINE_URL	Redmine 实例的 URL	http://localhost:3000
redmine_api_key	REDMINE_API_KEY	用于 Redmine 身份验证的 API 密钥	None
server_port	SERVER_PORT	MCP 服务的端口	5000
log_level	LOG_LEVEL	日志级别（INFO、DEBUG 等）	INFO
project_id	PROJECT_ID	默认 Redmine 项目 ID	1
default_category_id	DEFAULT_CATEGORY_ID	问题的默认类别 ID	3
default_tracker_id	DEFAULT_TRACKER_ID	问题的默认跟踪器 ID	2

流程优势

使用此 MCP 服务为 AI 辅助项目管理带来多项优势：

1. 结构化文档：所有 AI 工作都会自动记录在 Redmine 中
2. 明确流程：AI 任务遵循预定义的工作流和类别
3. 透明度：所有 AI 操作均有日志记录且可追溯
4. 协作：团队成员可以轻松审查 AI 工作并参与其中
5. 进度跟踪：项目经理可以通过 Redmine 跟踪 AI 任务进度

许可证

MIT 许可证

贡献

欢迎贡献！请随时提交 Pull Request。