星战科技xingzhan.cloud
返回市场
红矿MCP服务器

红矿MCP服务器

作者：jztan7 星标更新：2025-11-16
安装使用来源：spider==github.com

项目介绍

Redmine MCP 服务器

PyPI 版本 许可证 Python 版本 GitHub 问题 CI 下载量

一个与Redmine项目管理系统集成的Model Context Protocol (MCP)服务器。此服务器通过MCP工具提供对Redmine数据的无缝访问，使AI助手能够与您的Redmine实例进行交互。

mcp-name: io.github.jztan/redmine-mcp-server

工具参考 | 变更日志 | 贡献指南 | 故障排除

功能

  • Redmine 集成: 列出项目，查看/创建/更新问题，下载附件
  • HTTP 文件服务: 通过基于UUID的URL安全访问文件，并自动过期
  • MCP 兼容: 完全支持Model Context Protocol，采用FastMCP和可流式传输的HTTP传输
  • 灵活的身份验证: 用户名/密码或API密钥
  • 文件管理: 自动清理过期文件并统计存储情况
  • Docker 就绪: 完整容器化支持
  • 分页支持: 高效处理大型问题列表，具有可配置的限制

快速开始

  1. 安装包 
    pip install redmine-mcp-server
  2. 创建 .env 文件，包含您的Redmine凭证（参见安装获取模板）
  3. 启动服务器 
    redmine-mcp-server
  4. 将服务器添加到您的MCP客户端，使用MCP客户端配置中的指南之一。

运行后，服务器监听http://localhost:8000，MCP端点在/mcp，健康检查在/health，文件服务在/files/{file_id}。

安装

前提条件

  • Python 3.10+（用于本地安装）
  • Docker（替代部署，使用Python 3.13）
  • 访问Redmine实例

从PyPI安装（推荐）

# 安装包
pip install redmine-mcp-server

# 创建配置文件 .env
cat > .env << 'EOF'
# Redmine 连接（必需）
REDMINE_URL=https://your-redmine-server.com

# 身份验证 - 使用API密钥（推荐）或用户名/密码
REDMINE_API_KEY=your_api_key
# 或使用用户名/密码：
# REDMINE_USERNAME=your_username
# REDMINE_PASSWORD=your_password

# 服务器配置（可选，默认值显示）
SERVER_HOST=0.0.0.0
SERVER_PORT=8000

# 文件服务的公共URL（可选）
PUBLIC_HOST=localhost
PUBLIC_PORT=8000

# 文件管理（可选）
ATTACHMENTS_DIR=./attachments
AUTO_CLEANUP_ENABLED=true
CLEANUP_INTERVAL_MINUTES=10
ATTACHMENT_EXPIRES_MINUTES=60
EOF

# 编辑 .env 文件以包含您的实际Redmine设置
nano .env  # 或使用您喜欢的编辑器

# 启动服务器
redmine-mcp-server
# 或者：
python -m redmine_mcp_server.main

服务器运行在http://localhost:8000，MCP端点在/mcp，健康检查在/health，文件服务在/files/{file_id}。

环境变量

变量必需默认值描述
REDMINE_URL是–您的Redmine实例的基本URL
REDMINE_API_KEY是*–身份验证用的API密钥（或提供用户名/密码）
REDMINE_USERNAME是*–基本身份验证的用户名（与密码一起使用，当不使用API密钥时）
REDMINE_PASSWORD是*–基本身份验证的密码
SERVER_HOST否0.0.0.0MCP服务器绑定的主机/IP
SERVER_PORT否8000MCP服务器监听的端口
PUBLIC_HOST否localhost生成下载URL时使用的主机名
PUBLIC_PORT否8000下载URL使用的公共端口
ATTACHMENTS_DIR否./attachments下载附件的目录
AUTO_CLEANUP_ENABLED否true开启过期附件的自动清理
CLEANUP_INTERVAL_MINUTES否10清理任务的时间间隔
ATTACHMENT_EXPIRES_MINUTES否60生成的下载URL的有效时间窗口

* 必须提供REDMINE_API_KEY或REDMINE_USERNAME和REDMINE_PASSWORD的组合来进行身份验证。推荐使用API密钥进行身份验证，以提高安全性。

MCP客户端配置

服务器在http://127.0.0.1:8000/mcp暴露了一个HTTP端点。使用以下指令将其注册到您首选的MCP兼容代理中。

<details> <summary><strong>Visual Studio Code（内置MCP支持）</strong></summary>

VS Code通过GitHub Copilot内置了MCP支持（需要VS Code 1.102+）。

使用CLI（最快捷）：

code --add-mcp '{"name":"redmine","type":"http","url":"http://127.0.0.1:8000/mcp"}'

使用命令面板：

  1. 打开命令面板（Cmd/Ctrl+Shift+P）
  2. 运行MCP: 打开用户配置（全局）或MCP: 打开工作区文件夹配置（特定于项目）
  3. 添加配置： 
    {
  "servers": {
    "redmine": {
      "type": "http",
      "url": "http://127.0.0.1:8000/mcp"
    }
  }
}
  4. 保存文件。VS Code会自动加载MCP服务器。

手动配置： 在您的工作区中创建.vscode/mcp.json（或在您的用户配置文件目录中创建mcp.json）：

{
  "servers": {
    "redmine": {
      "type": "http",
      "url": "http://127.0.0.1:8000/mcp"
    }
  }
}
</details> <details> <summary><strong>Claude Code</strong></summary>

使用CLI命令添加到Claude Code：

claude mcp add --transport http redmine http://127.0.0.1:8000/mcp

或者在您的Claude Code设置文件（~/.claude.json）中手动配置：

{
  "mcpServers": {
    "redmine": {
      "type": "http",
      "url": "http://127.0.0.1:8000/mcp"
    }
  }
}
</details> <details> <summary><strong>Codex CLI</strong></summary>

使用命令添加到Codex CLI：

codex mcp add redmine -- npx -y mcp-client-http http://127.0.0.1:8000/mcp

或者在~/.codex/config.toml中手动配置：

[mcp_servers.redmine]
command = "npx"
args = ["-y", "mcp-client-http", "http://127.0.0.1:8000/mcp"]

注意： Codex CLI主要支持基于stdio的MCP服务器。上述配置使用mcp-client-http作为HTTP传输的桥梁。

</details> <details> <summary><strong>Kiro</strong></summary>

Kiro主要支持基于stdio的MCP服务器。对于HTTP服务器，使用stdio到HTTP的桥梁：

  1. 在您的工作区中创建或编辑.kiro/settings/mcp.json： 
    {
  "mcpServers": {
    "redmine": {
      "command": "npx",
      "args": [
        "-y",
        "mcp-client-http",
        "http://127.0.0.1:8000/mcp"
      ],
      "disabled": false
    }
  }
}
  2. 保存文件并重启Kiro。Redmine工具将在MCP面板中出现。

注意： Kiro对直接HTTP传输的支持有限。上述配置使用mcp-client-http作为桥梁连接到HTTP MCP服务器。

</details> <details> <summary><strong>通用MCP客户端</strong></summary>

大多数MCP客户端使用标准配置格式。对于HTTP服务器：

{
  "mcpServers": {
    "redmine": {
      "type": "http",
      "url": "http://127.0.0.1:8000/mcp"
    }
  }
}

对于需要命令方式并通过HTTP桥梁的客户端：

{
  "mcpServers": {
    "redmine": {
      "command": "npx",
      "args": ["-y", "mcp-client-http", "http://127.0.0.1:8000/mcp"]
    }
  }
}
</details>

测试您的设置

# 通过检查健康端点测试连接
curl http://localhost:8000/health

可用工具

此MCP服务器提供了10个工具来与Redmine交互。详细的文档，请参阅工具参考。

Docker 部署

使用Docker快速开始

# 配置环境
cp .env.example .env.docker
# 编辑 .env.docker 文件以包含您的Redmine设置

# 使用docker-compose运行
docker-compose up --build

# 或直接运行
docker build -t redmine-mcp-server .
docker run -p 8000:8000 --env-file .env.docker redmine-mcp-server

生产部署

使用自动化部署脚本：

chmod +x deploy.sh
./deploy.sh

故障排除

如果您遇到任何问题，请查阅我们的故障排除指南。

贡献

欢迎贡献！请参阅我们的贡献指南了解详情。

许可证

本项目根据MIT许可证发布 - 详情请参阅LICENSE文件。

额外资源