Redmine问题获取MCP服务器

一个符合MCP协议的服务器,用于帮助AI代理高效获取Redmine中的问题。

  • by paterapatera
  • TypeScript
  • 本地部署
  • 更新于
在 GitHub 查看 paterapatera/redmine-mcp

使用说明

Redmine MCP服务器

获取Redmine中的问题的“MCP”服务器。使AI代理能够有效地获取Redmine的问题。

概要

该项目实施符合MCP协议的服务器,并提供获取Redmine问题的功能。可从Claude Desktop或其他MCP客户端使用。

主要功能

  • ✅ 符合MCP协议:标准MCP服务器实现
  • ✅ Redmine获取:获取Redmine中的问题
  • ✅ 错误处理:统一的错误处理策略
  • ✅ 记录:记录

前提条件

安装,安装

1.克隆存储库

git clone https://github.com/paterapatera/redmine-mcp.git
cd redmine-mcp

2.安装相关性

bun install

3.设置环境变量

必需的环境变量:

export REDMINE_API_KEY="your-api-key-here"
export REDMINE_URL="https://redmine.example.com"

4.构建

bun run build

构建后dist/index.js 将条目添加到文档注册表。

使用方法

在总线上安装

在本地开发环境中使用时bun link 使用:

# プロジェクトディレクトリで実行
bun link

# グローバルにリンクされた後、どこからでも実行可能
redmine-mcp

指定环境变量时:

REDMINE_API_KEY="your-api-key-here" REDMINE_URL="https://redmine.example.com" redmine-mcp

用作MCP客户端

此服务器来自MCP客户端(例如,Claude Desktop,MCP检查器)。

在Claude Desktop中设置

claude_desktop_config.json 添加:

使用bun link时(推奨):

{
  "mcpServers": {
    "redmine-mcp": {
      "command": "redmine-mcp",
      "env": {
        "REDMINE_API_KEY": "your-api-key-here",
        "REDMINE_URL": "https://redmine.example.com"
      }
    }
  }
}

bun link 中描述的相应参数的值redmine-mcp 命令可用。

使用本地路径时:

{
  "mcpServers": {
    "redmine-mcp": {
      "command": "bun",
      "args": ["/path/to/redmine-mcp/dist/index.js"],
      "env": {
        "REDMINE_API_KEY": "your-api-key-here",
        "REDMINE_URL": "https://redmine.example.com"
      }
    }
  }
}

直接実行

bun dist/index.js

但是,通常通过MCP客户端使用。

测试

单元测试

bun test

使用MCP检验器的E2E测试

有关如何使用MCP检查器测试服务器的信息MCP_INSPECTOR_GUIDE.md 来修改标记元素的显示属性。

简单步骤:

# 1. 環境変数を設定
export REDMINE_API_KEY="your-api-key-here"
export REDMINE_URL="https://redmine.example.com"

# 2. ビルド
bun run build

# 3. MCP Inspector を起動
bun run inspector

体系结构

环境变数

变数名 必须 说明
|REDMINE_API_KEY|是|Redmine的API键|
REDMINE_URL是Redmine实例的基本URL

故障排除

开発

开发环境设置

# 依存関係のインストール
bun install

# 開発モードでテストを実行
bun test --watch

# ビルド
bun run build

代码样式

  • 使用类型脚本
  • 符合统一错误处理策略

许可证

国际学生委员会

参考链接

貢献

这个项目是个人项目。如果有问题或建议,请创建Issue。


注意:此项目包括 bun link 中描述的场景,使用以下步骤创建明细表,以便在概念设计中分析体量的体积。不设想向npm公开。