Redmine WikiのAPIを使用したModel Context Protocol (MCP) サーバーです。Claude DesktopやClaude Code等のMCPクライアントからRedmine Wiki情報にアクセスできます。
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キー
- プロジェクトへのアクセス権限
npm install.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
npm run buildClaude 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/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フラグを付けて起動すると、Streamable HTTPトランスポートで動作します:
node dist/index.js --httpデフォルトではポート3000で起動し、http://0.0.0.0:3000/mcpでリクエストを受け付けます。PORT環境変数でポートを変更できます:
PORT=8080 node dist/index.js --httpnpm run devnpm run buildキーワードでRedmine Wiki内を検索します。
パラメータ:
query(string, required): 検索キーワード
戻り値: 検索にヒットしたWikiページの一覧(タイトル、説明、URL)
プロジェクト内のすべてのWikiページの一覧を取得します。
パラメータ: なし
戻り値: Wikiページの一覧(タイトル、バージョン、更新日時)
指定したタイトルのWikiページの全文を取得します。
パラメータ:
title(string, required): Wikiページのタイトル
戻り値: ページの全文、更新日時、作成者、バージョン
キーワードでWikiを検索し、関連するページの全文を取得します。
パラメータ:
query(string, required): 検索キーワードまたは質問
戻り値: 関連するWikiページの全文(最大5件)
- 環境変数が正しく設定されているか確認してください
- Node.js 18以上がインストールされているか確認してください
npm run buildでビルドが成功しているか確認してください
REDMINE_URLが正しいか確認してくださいAPI_KEYが有効か確認してくださいPROJECT_IDが正しいか確認してください- Redmineの設定でREST APIが有効になっているか確認してください
- MCP SDK: @modelcontextprotocol/sdk v1.25.x
- トランスポート: stdio (標準入出力) / Streamable HTTP (
--httpフラグで切替) - プロトコルバージョン: 2024-11-05
MIT