使用说明
红矿mcp
用于处理Redmine票据的MCP(Model Context Protocol)服务器。可以从Cursor或Claude Desktop等获取、一览、创建、更新票证。
要件
- Node.js 18.0.0 以上
- Redmine中REST API有效
- Redmine的API访问密钥(通过个人设置获取)
安装,安装
不需要克隆或构建,只需放置以下两个文件:。
.cursor/redmine.json中所述修改相应参数的值。放置在以下任意位置:。- 工作区根目录(推荐):想根据每个项目改变设定时
~/.cursor/redmine.json(主页):在多个项目中使用相同的设置时。在工作区中没有设置时作为回退读取
{
"redmineUrl": "https://your-redmine.example.com",
"apiKey": "your-api-access-key"
}
.cursor/mcp.json中添加必要的图元。
{
"mcpServers": {
"redmine": {
"command": "npx",
"args": ["-y", "github:ytakeuchi0222/redmine-mcp"]
}
}
}
首次运行时,由于存储库的检索和构建会运行,所以需要一点时间。MCP服务器在启动时当前目录为基准 .cursor/redmine.json (在Cursor中启动MCP时,当前目录通常设置为“打开的文件夹”=工作区根目录)。
注意: redmine.json 因为包含API密钥,所以在git管理的情况下.gitignore 中描述的场景,使用以下步骤创建明细表,以便在概念设计中分析体量的体积。
交付工具
工具名称|说明|
|----------|------|
| get_issue 取得一张票(issue_id 必须)|
| list_issues 获取票证列表(project_id, status_id, assigned_to_id, limit, offset 中所述修改相应参数的值。limit 最多100)
| create_issue 新建票证(project_id, subject 必须)|
| update_issue 更新票证(issue_id 必须。subject, description, status_id, assigned_to_id 是可选的
具体的使用方法
1.准备确认
- Redmine API密钥:登录Redmine→个人设置→用API访问密钥“显示”,复制密钥。
- 配置文件:打开此存储库后
.cursor/redmine.json中保存以下内容(值适合自己的环境)。
{
"redmineUrl": "https://あなたのRedmineのURL",
"apiKey": "ここにAPIキーを貼る"
}
2.Cursor使用
当您在工作区中打开此存储库时,如果在**聊天**中这样说,AI将调用Redmine MCP工具:。
想做的事|聊天输入的例子| |--------------|----------------------| 查看一张票“请告诉我票#123的内容” 获取列表“提交10个项目5的票证列表” 只提供负责的票“列出分配给自己的票” 仅未完成:状态为open的20个票证 制作门票“在项目1中以‘〇〇的问题’为主题制作门票” 更新票证-将票证#456的状态更改为“已支持”
不指定工具名称想做的事用日语写只是AI get_issue / list_issues / create_issue / update_issue 中所述修改相应参数的值。
3.各工具参数(参考)
- 获取问题:
issue_id(例: 123) - list_issues:
project_id,status_id(数値 oropen/closed/*),assigned_to_id(数値 orme),limit,offset(均为任意) - 创建_发行:
project_id,subject(必须),description,tracker_id,status_id,priority_id,assigned_to_id(任意) - update_issue:
issue_id(必须),subject,description,status_id,assigned_to_id(任意)
4.不能顺利运转时
- “未找到服务器信息”:MCP服务器未启动。
.cursor/mcp.json的设置是否正确,重新启动MCP。 - 找不到配置文件:MCP为(1)工作区的
.cursor/redmine.json、(2)~/.cursor/redmine.json求值时使用曲面法线的原始方向。在哪边redmine.json请确认是否放置了。如果两者都没有,则显示“工作区中的.cursor/redmine.json和~/.cursor/redmine.json都找不到”。 - 4xx/5xx错误:确认Redmine的URL API密钥、REST API有效化、项目ID和票证ID是否正确。
参照
- 要求定义・要件定义・実装方针:
docs/属下的Markdown - Redmine REST API(问题)