AI导哈

Redmine Wiki API服务器

一个基于Redmine Wiki API的Model Context Protocol (MCP)服务器，允许MCP客户端如Claude Desktop和Claude Code访问Redmine Wiki信息。

  • by kano-lab
  • TypeScript
  • 本地部署
  • 1 星标
  • 更新于
在 GitHub 查看 kano-lab/redmine-mcp

使用说明

Redmine Wiki MCP服务器

使用Redmine Wiki API的Model Context Protocol（MCP）服务器。可从Claude Desktop或Claude Code等MCP客户端访问Redmine Wiki信息。

什么是MCP

模型上下文协议（MCP） 是用于连接大规模语言模型和外部数据源工具的开放协议。通过使用MCP，AI助手可以获取外部系统的信息，提供更准确的回答。

机能

此MCP服务器提供以下工具：

工具名称｜说明｜ |---------|------| | search_wiki 用关键字搜索维客页面 | list_wiki_pages 获取项目中的维客页面列表 | get_wiki_page 获取特定维客页面的全文 | 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

将MCP服务器添加到Claude Desktop的配置文件中。

配置文件位置

  • macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
  • 视窗: %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标记并启动时，可在可流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

使用关键字在注册维客中搜索。

参数：

  • query （string，required）：搜索关键字

返回值： 搜索成功的维客页面列表（标题、说明、URL）

list_wiki_pages

获取项目中所有维客页面的列表。

参数： 无

返回值： 维客页面列表（标题、版本和更新时间）

get_wiki_page

获取指定标题的维客页面的全文。

参数：

  • title （string，required）：维客页面标题

返回值： 页面全文、更新时间、作者和版本

search_and_get_page

使用关键字搜索维客并获取相关页面的全文。

参数：

  • query （string，required）：搜索关键字或问题

返回值： 相关维客页面全文（最多5篇）

故障排除

服务器未启动

  1. 请确认环境变量是否设置正确
  2. 请确认是否安装了Node.js18以上
  3. npm run build中描述的场景，使用以下步骤创建明细表，以便在概念设计中分析体量的体积

无法访问Redmine API

  1. REDMINE_URL请确认是否正确
  2. API_KEY请确认是否有效
  3. PROJECT_ID请确认是否正确
  4. 请确认Redmine设置是否启用了REST API

技术情报

  • MCP-SDK: @模型上下文协议/sdk v1.25.x
  • 传输：stdio（标准入出力）/ Streamable HTTP（--http用标志切换）
  • 协议版本: 2024-11-05

参考链接

许可证

麻省理工学院

相关 MCP