使用说明
mcp红矿
一 MCP(模型上下文协议) 将AI代理连接到的服务器 红矿 项目管理。让人工智能助手列出问题、创建任务、搜索项目、记录时间、阅读Wiki等等,所有这些都通过Redmine的REST API实现。
特性
- 🔑 灵活的身份验证 -API密钥、基本身份验证或同时使用
- 📋 问题 --列表、获取、创建、更新(带过滤器、分页、日记)
- 📁 项目 --列出并获取项目详细信息(包括跟踪器、类别、模块)
- 👤 用户 --获取当前用户,列出用户(管理员)
- ⏱️ 时间跟踪 --列出并创建时间条目
- 📖 维基 --获取并列出wiki页面(带版本控制)
- 🔍 搜索 --Redmine全文搜索
先决条件
- Node.js ≥ 18
- A. 红矿 启用REST API的实例 (行政→ 设置→ API → 启用REST(API)
配置
服务器是通过环境变量配置的:
| 变量 | 必填 | 描述 |
|---|---|---|
REDMINE_URL |
✅ | Redmine实例的基本URL(例如。 https://redmine.example.com) |
REDMINE_API_KEY |
⚡ | API密钥(在我的帐户中找到→ API访问密钥) |
REDMINE_USERNAME |
⚡ | 基本身份验证的用户名 |
REDMINE_PASSWORD |
⚡ | 基本身份验证密码 |
⚡ 要么
REDMINE_API_KEY或REDMINE_USERNAME+REDMINE_PASSWORD是必需的。您还可以同时提供-Basic Auth和API密钥将一起发送。
用法
VS代码(双子座/副驾驶)
添加 .vscode/mcp.json:
{
"servers": {
"mcp-redmine": {
"command": "npx",
"args": ["-y", "@hoangconghuy/mcp-redmine"],
"env": {
"REDMINE_URL": "https://redmine.example.com",
"REDMINE_API_KEY": "your-api-key"
}
}
}
}
克劳德桌面版
添加 claude_desktop_config.json:
{
"mcpServers": {
"mcp-redmine": {
"command": "npx",
"args": ["-y", "@hoangconghuy/mcp-redmine"],
"env": {
"REDMINE_URL": "https://redmine.example.com",
"REDMINE_API_KEY": "your-api-key"
}
}
}
}
直接运行
REDMINE_URL=https://redmine.example.com \
REDMINE_API_KEY=your-api-key \
npx -y @hoangconghuy/mcp-redmine
可用工具
| 工具 | 说明 |
|---|---|
list-issues |
列出过滤器问题(项目、状态、跟踪器、受让人、排序、分页) |
get-issue |
获取一期包含完整细节和可选关联(期刊、附件等)的期刊 |
create-issue |
在全面的现场支持下创建新问题(跟踪器、优先级、日期等) |
update-issue |
更新现有问题(字段、状态、注释、完成率) |
list-projects |
列出所有具有可选关联的可访问项目 |
get-project |
通过ID或标识符获取项目详细信息 |
get-current-user |
获取经过身份验证的用户的信息(包括成员资格和组) |
list-users |
列出具有筛选器的用户(仅限管理员) |
list-time-entries |
列出带有过滤器的时间条目(项目、用户、日期范围) |
create-time-entry |
记录问题或项目的时间 |
get-wiki-page |
获取wiki页面的内容(支持版本) |
list-wiki-pages |
列出项目中的所有wiki页面 |
search-redmine |
Redmine上的全文搜索(问题、项目、维基等) |
发展
npm install
npm run dev # Watch mode (auto-recompile on changes)
npm run build # One-time build
npm start # Run the built server
许可证
麻省理工学院