@alarmzb/redmine
v1.0.1
Published
Redmine MCP Server for AI agents
Readme
@alarmzb/redmine
Redmine (aka PSC) MCP Server — 讓 AI Agent 存取 Redmine issues、討論、附件圖片。
安裝
Claude Code
claude mcp add redmine -- npx -y @alarmzb/redmine其他 client (Claude Desktop / Codex / Roo Code / OpenCode)
在設定檔中加入:
{
"mcpServers": {
"redmine": {
"command": "npx",
"args": ["-y", "@alarmzb/redmine"]
}
}
}.env 設定
憑證預設存放在當前工作目錄的 .env,由 redmine_set_url / redmine_set_credentials tool 自動寫入。亦可手動建立。
正確的環境變數名稱
| 變數 | 必填 | 說明 |
|------|------|------|
| REDMINE_URL | ✅ | Redmine 伺服器 URL,例如 https://redmine.example.com |
| REDMINE_API_KEY | 擇一 | Redmine 個人 API Key(推薦) |
| REDMINE_USERNAME | 擇一 | 帳號(與 REDMINE_PASSWORD 搭配) |
| REDMINE_PASSWORD | 擇一 | 密碼 |
注意:變數名稱固定為
REDMINE_*,不是JIRA_*。此套件與 JIRA 無關。
範例 .env
REDMINE_URL=https://redmine.example.com
REDMINE_API_KEY=your-api-key-here自訂 .env 路徑
透過 MCP client 的 env 欄位設定 DOTENV_PATH,可讓多專案共用同一份 .env:
{
"mcpServers": {
"redmine": {
"command": "npx",
"args": ["-y", "@alarmzb/redmine"],
"env": { "DOTENV_PATH": "/home/you/.redmine.env" }
}
}
}Tools
| Tool | 說明 |
|------|------|
| redmine_set_url | 設定 REDMINE_URL(寫入 .env) |
| redmine_set_credentials | 設定 API Key 或 帳號/密碼(寫入 .env) |
| redmine_get_issue | 取得 issue 完整內容(含討論與附件圖片 base64) |
| redmine_search_issues | 搜尋 issues(支援狀態、專案、指派者篩選) |
| redmine_get_attachment | 下載指定附件 |
首次使用
設定完 MCP client 後重啟 AI Agent,對 AI 說:
幫我設定 Redmine:
- URL: https://your-redmine-server
- API Key: your-api-keyAI 會自動呼叫 redmine_set_url 與 redmine_set_credentials 寫入 .env。之後問 PSC #1231 / Redmine #1231 即可查詢。
相關
- Repo: https://github.com/alarmz/mcp-hub
- 搭配套件:
@alarmzb/nfd-generator(從 PSC 內容自動產生 NFD 文件)
