Skip to content

kano-lab/redmine-mcp

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

6 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Redmine Wiki MCP Server

Redmine WikiのAPIを使用したModel Context Protocol (MCP) サーバーです。Claude DesktopやClaude Code等のMCPクライアントからRedmine Wiki情報にアクセスできます。

MCPとは

Model Context Protocol (MCP) は、LLM(大規模言語モデル)と外部データソース・ツールを接続するためのオープンプロトコルです。MCPを使用することで、AIアシスタントが外部システムの情報を取得し、より的確な回答を提供できるようになります。

機能

このMCPサーバーは以下のツールを提供します:

ツール名 説明
search_wiki キーワードでWikiページを検索
list_wiki_pages プロジェクト内のWikiページ一覧を取得
get_wiki_page 特定のWikiページの全文を取得
search_and_get_page キーワードで検索し、関連ページの全文を取得(最大5件)

動作要件

  • Node.js 18.0.0 以上
  • Redmine APIキー
  • プロジェクトへのアクセス権限

セットアップ

1. 依存関係のインストール

npm install

2. 環境変数の設定

.env.exampleファイルを.envにコピーして、必要な情報を設定します:

cp .env.example .env

.envファイルを編集:

REDMINE_URL=https://your-redmine-domain.com
API_KEY=your_redmine_api_key
PROJECT_ID=your_project_id

3. ビルド

npm run build

Claude Desktop での使用方法

Claude Desktopの設定ファイルにMCPサーバーを追加します。

設定ファイルの場所

  • macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
  • Windows: %APPDATA%\Claude\claude_desktop_config.json

設定例

{
  "mcpServers": {
    "redmine-wiki": {
      "command": "node",
      "args": ["/path/to/redmine-mcp/dist/index.js"],
      "env": {
        "REDMINE_URL": "https://your-redmine-domain.com",
        "API_KEY": "your_redmine_api_key",
        "PROJECT_ID": "your_project_id"
      }
    }
  }
}

または、.envファイルを使用する場合:

{
  "mcpServers": {
    "redmine-wiki": {
      "command": "node",
      "args": ["/path/to/redmine-mcp/dist/index.js"]
    }
  }
}

設定後、Claude Desktopを再起動してください。

Claude Code での使用方法

Claude Codeの設定ファイル(~/.claude/settings.json)にMCPサーバーを追加します:

{
  "mcpServers": {
    "redmine-wiki": {
      "command": "node",
      "args": ["/path/to/redmine-mcp/dist/index.js"],
      "env": {
        "REDMINE_URL": "https://your-redmine-domain.com",
        "API_KEY": "your_redmine_api_key",
        "PROJECT_ID": "your_project_id"
      }
    }
  }
}

HTTPモードでの使用方法

--httpフラグを付けて起動すると、Streamable HTTPトランスポートで動作します:

node dist/index.js --http

デフォルトではポート3000で起動し、http://0.0.0.0:3000/mcpでリクエストを受け付けます。PORT環境変数でポートを変更できます:

PORT=8080 node dist/index.js --http

開発

開発モードで実行

npm run dev

ビルド

npm run build

提供ツールの詳細

search_wiki

キーワードでRedmine Wiki内を検索します。

パラメータ:

  • query (string, required): 検索キーワード

戻り値: 検索にヒットしたWikiページの一覧(タイトル、説明、URL)

list_wiki_pages

プロジェクト内のすべてのWikiページの一覧を取得します。

パラメータ: なし

戻り値: Wikiページの一覧(タイトル、バージョン、更新日時)

get_wiki_page

指定したタイトルのWikiページの全文を取得します。

パラメータ:

  • title (string, required): Wikiページのタイトル

戻り値: ページの全文、更新日時、作成者、バージョン

search_and_get_page

キーワードでWikiを検索し、関連するページの全文を取得します。

パラメータ:

  • query (string, required): 検索キーワードまたは質問

戻り値: 関連するWikiページの全文(最大5件)

トラブルシューティング

サーバーが起動しない

  1. 環境変数が正しく設定されているか確認してください
  2. Node.js 18以上がインストールされているか確認してください
  3. npm run buildでビルドが成功しているか確認してください

Redmine APIにアクセスできない

  1. REDMINE_URLが正しいか確認してください
  2. API_KEYが有効か確認してください
  3. PROJECT_IDが正しいか確認してください
  4. Redmineの設定でREST APIが有効になっているか確認してください

技術情報

  • MCP SDK: @modelcontextprotocol/sdk v1.25.x
  • トランスポート: stdio (標準入出力) / Streamable HTTP (--httpフラグで切替)
  • プロトコルバージョン: 2024-11-05

参考リンク

ライセンス

MIT

About

RedmineのWikiページをLLMに食わせるためのMCPサーバーの実装

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors