Skip to main content
Glama
redmine-local-mcp

redmine-local-mcp

redmine-local-mcp

Redmine REST API を MCP ツールとして公開するローカル STDIO サーバーです。 Codex CLI / GitHub Copilot CLI などの MCP クライアントから、Redmine のプロジェクトやチケットを参照できます。

方針

  • Redmine は直接クラウド側へ公開せず、開発者 PC 上のローカル MCP サーバーから REST API に接続します。

  • API キーは専用ユーザーの最小権限キーを使います。

  • 初期状態では読み取り中心です。書き込み系の create_issue / add_issue_note は REDMINE_ENABLE_WRITE=true のときだけ動きます。

Related MCP server: Redmine MCP Server

機能

  • プロジェクト一覧の取得

  • チケット検索、チケット詳細取得、自分の担当チケット取得

  • 明示的に有効化した場合のみ、チケット作成とコメント追加

セットアップ

git clone https://github.com/<owner>/redmine-local-mcp.git
cd redmine-local-mcp
npm install
npm run build

.env.example を参考に、MCP クライアント側の環境変数として次の値を渡してください。 .env はローカル開発用で、Git にコミットしないでください。

REDMINE_URL=https://redmine.example.local
REDMINE_API_KEY=xxxxxxxxxxxxxxxx
REDMINE_ENABLE_WRITE=false

MCP クライアント設定

以下の例では、このリポジトリを /path/to/redmine-local-mcp に clone したものとして書いています。 実際の環境に合わせてパスを置き換えてください。

Codex CLI

[mcp_servers.redmine]
command = "node"
args = ["/path/to/redmine-local-mcp/dist/index.js"]
default_tools_approval_mode = "prompt"

[mcp_servers.redmine.env]
REDMINE_URL = "https://redmine.example.local"
REDMINE_API_KEY = "xxxxxxxxxxxxxxxx"
REDMINE_ENABLE_WRITE = "false"

GitHub Copilot CLI

copilot mcp add redmine \
  --env REDMINE_URL=https://redmine.example.local \
  --env REDMINE_API_KEY=xxxxxxxxxxxxxxxx \
  --env REDMINE_ENABLE_WRITE=false \
  -- node /path/to/redmine-local-mcp/dist/index.js

Agent Skill

Redmine MCP の使い方や安全ルールをまとめた Agent Skill を同梱しています。 このリポジトリでは Skill の原本だけを管理し、使う環境のユーザープロファイルへ手動でコピーします。

Skill 本体:

agent-skills/redmine-workflows/SKILL.md

GitHub Copilot の個人用 Skill として使う場合のコピー例:

New-Item -ItemType Directory -Force "$env:USERPROFILE\.copilot\skills\redmine-workflows"
Copy-Item -Recurse -Force .\agent-skills\redmine-workflows\* "$env:USERPROFILE\.copilot\skills\redmine-workflows\"

.agents 配下で Skill を管理する環境では、コピー先を次のように置き換えます。

New-Item -ItemType Directory -Force "$env:USERPROFILE\.agents\skills\redmine-workflows"
Copy-Item -Recurse -Force .\agent-skills\redmine-workflows\* "$env:USERPROFILE\.agents\skills\redmine-workflows\"

この Skill には API キーや Redmine URL は含めません。接続情報は MCP クライアント設定の環境変数で渡してください。

提供ツール

  • list_projects: プロジェクト一覧を取得します。

  • search_issues: チケットを検索します。

  • get_issue: チケット詳細を取得します。

  • get_my_issues: 自分に割り当てられたチケットを取得します。

  • create_issue: チケットを作成します。REDMINE_ENABLE_WRITE=true が必要です。

  • add_issue_note: チケットにコメントを追加します。REDMINE_ENABLE_WRITE=true が必要です。

設計メモ

設計判断や拡張時の注意点は docs/code-guide.md にまとめています。

主なファイル:

  • src/index.ts: MCPツールを登録する入口です。

  • src/redmineClient.ts: Redmine REST APIを呼び出す処理です。

  • src/config.ts: 環境変数を読み込む処理です。

  • tests/: 実Redmineへ接続せずに動作を確認するテストです。

書き込み系を有効にする

チケット作成やコメント追加を行う場合は、環境変数を次のように設定します。

REDMINE_ENABLE_WRITE=true

create_issue の最小入力例:

{
  "project_id": "sample-project",
  "subject": "ログイン画面のエラーを確認する",
  "description": "再現手順と期待結果を整理する。"
}

add_issue_note の入力例:

{
  "id": 1234,
  "notes": "調査を開始しました。再現条件を確認中です。"
}

開発

npm run typecheck
npm run build
npm test

テストは実 Redmine へ接続せず、HTTP 呼び出しをモックします。

セキュリティ

  • REDMINE_API_KEY は専用ユーザーの最小権限キーを使ってください。

  • .env や実 URL を含む MCP クライアント設定はコミットしないでください。

  • 書き込みツールは REDMINE_ENABLE_WRITE=true を明示した場合だけ有効です。

  • 脆弱性や秘密情報の混入を見つけた場合は、公開 issue ではなくリポジトリ管理者へ非公開で連絡してください。

公開前チェックリスト

  • .env が Git 管理対象になっていないことを確認する。

  • README 内の <owner> と /path/to/redmine-local-mcp を公開先に合わせる。

  • Agent Skill に実 Redmine の URL、API キー、社内固有の非公開ルールが含まれていないことを確認する。

  • 実 Redmine の URL、API キー、社内プロジェクト名が含まれていないことを確認する。

  • npm run typecheck、npm run build、npm test が通ることを確認する。

ライセンス

MIT License

Available Tools

6 tools
add_issue_noteAdd Redmine Issue NoteB

Add a note/comment to a Redmine issue. Requires REDMINE_ENABLE_WRITE=true.

Inputs: id (required), notes (required).

create_issueCreate Redmine IssueB

Create a Redmine issue. Requires REDMINE_ENABLE_WRITE=true.

Inputs: subject (required), project_id (required), due_date, status_id, +10 more.

get_issueGet Redmine IssueA

Get a Redmine issue by id, optionally including journals, attachments, relations, children, or watchers.

Inputs: id (required), include.

get_my_issuesGet My Redmine IssuesB

Get issues assigned to the configured Redmine API user.

Inputs: sort, limit, offset, status_id, +1 more.

list_projectsList Redmine ProjectsA

List projects visible to the configured Redmine API user.

Inputs: limit, offset.

search_issuesSearch Redmine IssuesA

Search Redmine issues by common filters. Optional text is applied client-side to subject and description.

Inputs: sort, text, limit, offset, +6 more.

Tool Schema Changelog

Recent tool additions, removals, and schema changes observed during successful MCP inspections.

Loading tool schema changelog…

    TDQS

    A3.7/5.0

    Scored across 6 tools

    Disambiguation5/5

    Each tool targets a distinct resource and action: projects vs. issues, search vs. by-id, create vs. note. Even search_issues and get_my_issues are clearly differentiated by scope (all issues vs. assigned to the API user).

    Naming Consistency5/5

    All tool names follow the consistent verb_noun pattern with lowercase and underscores: list_projects, search_issues, get_issue, get_my_issues, create_issue, add_issue_note. No mixed conventions or vague verbs.

    Tool Count5/5

    Six tools is a well-scoped count for a Redmine MCP server, covering core read and write operations without superfluous entries. The set feels neither thin nor bloated.

    Completeness3/5

    The server covers project listing, issue search/retrieval, issue creation, and note addition, but lacks update and delete operations for issues. This is a notable gap for full lifecycle management, as agents cannot change status, assignee, or priority.

    Maintenance

    ActivityInactive
    ResponsivenessNo recent community issues

    Related MCP Connectors

    Related MCP Servers

    • A
      license
      Not graded
      quality
      B
      maintenance
      A stateless MCP server for Redmine that allows users to interact with issues, time entries, wiki, projects, and more via their own API keys.
      4
      MIT
    • A
      license
      B
      quality
      D
      maintenance
      MCP server for Redmine project management, enabling tools for managing projects, issues, users, time entries, groups, memberships, versions, wiki, news, attachments, search, and Agile sprints via the Redmine REST API.
      89
      21 npm
      1
      MIT
    • A
      license
      C
      quality
      B
      maintenance
      Model Context Protocol (MCP) server for Redmine that provides comprehensive access to the Redmine REST API. It allows you to operate Redmine from MCP clients such as Claude Desktop.
      90
      1,256 npm
      30
      MIT

    Appeared in Searches