# redmine-mcp

セルフホスト Redmine([redmine.dokkiitech.dev](https://redmine.dokkiitech.dev))を
Claude Code から操作するための MCP サーバー(stdio)です。

## セットアップ

前提: [uv](https://docs.astral.sh/uv/) がインストール済みであること。

### 1. Redmine の API キーを発行する

1. Redmine にログイン
2. 右上「マイアカウント」→ 右サイドバー「APIアクセスキー」→「表示」
3. 表示されたキーを控える

### 2. Claude Code に登録する

```bash
claude mcp add --scope user redmine \
  --env REDMINE_API_KEY=<自分のAPIキー> \
  -- uvx --from git+https://github.com/dokkiitech/redmine-mcp redmine-mcp
```

登録後、Claude Code を再起動すると `redmine` サーバーが接続されます。
確認は `claude mcp get redmine`。

## 環境変数

| 変数 | 必須 | 説明 |
| --- | --- | --- |
| `REDMINE_API_KEY` | ✔ | Redmine の API アクセスキー(各自発行) |
| `REDMINE_URL` | - | 接続先(既定: `https://redmine.dokkiitech.dev`) |

## 提供ツール

| ツール | 説明 |
| --- | --- |
| `list_projects` / `get_project` | プロジェクト一覧・詳細(有効トラッカー・モジュール込み) |
| `create_project` / `update_project` / `delete_project` | プロジェクトの作成・更新・削除 |
| `list_issues` | チケット一覧(プロジェクト・ステータス・担当者・件名で絞り込み) |
| `get_issue` | チケット詳細(コメント履歴・添付・遷移可能ステータス込み) |
| `create_issue` | チケット作成(custom_fields 対応) |
| `update_issue` | チケット更新(コメント追加・ステータス変更・進捗率・custom_fields など) |
| `delete_issue` | チケット削除(取り消し不可) |
| `list_wiki_pages` / `read_wiki_page` / `write_wiki_page` / `delete_wiki_page` | Wiki の一覧・取得・作成更新・削除 |
| `create_time_entry` / `list_time_entries` / `update_time_entry` / `delete_time_entry` | 作業時間の記録・一覧・修正・削除 |
| `upload_attachment` / `download_attachment` | ファイルのアップロード(トークン発行)・添付の取得 |
| `list_files` / `add_project_file` | プロジェクトの「ファイル」一覧・登録(files モジュール必須) |
| `search` | 全文検索(チケット・Wiki・ニュース等) |
| `list_metadata` | トラッカー / ステータス / 優先度 / ユーザー / 作業分類の ID 一覧 |

> **文書(Documents)モジュールは Redmine コアの REST API 非対応**のため操作できません。ファイル共有はプロジェクトの「ファイル」(files モジュール)か Wiki を使ってください。

リモート版(Cloudflare Worker、ChatGPT / スマホのコネクタ用)は [`remote/`](remote/) を参照。

## 注意

- Redmine サーバー(EC2)は **3時〜12時 JST は停止**しています。接続エラーが出たら稼働時間帯(12時〜翌3時 JST)か確認してください
- Redmine の REST API は不正な値(存在しないカスタムフィールド ID など)を**エラーにせず黙って無視**します。更新系操作のあとは `get_issue` で読み返して反映を確認するのが安全です

## 更新の取り込み

`uvx` は git リポジトリをキャッシュします。新しいバージョンを取り込むには:

```bash
uv cache clean redmine-mcp
```

## 開発

```bash
git clone https://github.com/dokkiitech/redmine-mcp
cd redmine-mcp
REDMINE_API_KEY=<key> uv run redmine-mcp  # stdio で起動(Ctrl+C で終了)
```

## License

MIT