Backlog MCP Server

🚀 Backlog MCP 服务器

Backlog MCP 服务器是一款用于特定业务场景的服务器工具，可通过 Docker 或常规方式安装，支持灵活配置和多语言设置，方便开发者进行开发和测试。

🚀 快速开始

你可以按照以下步骤快速搭建并使用 Backlog MCP 服务器：

1. 安装服务器。
2. 进行相关配置。
3. 启动服务器开始使用。

📦 安装指南

使用 Docker 安装

运行以下命令使用 Docker 安装：

docker run -i --rm ghcr.io/nulab/backlog-mcp-server

或者直接运行镜像：

npx github:nulab/backlog-mcp-server

⚙️ 配置说明

默认配置文件

默认配置文件为 ~/.backlog-mcp-serverrc.json。

定制配置文件

在你的工作目录中创建或修改 mcp-config.json 文件，内容如下：

{
  "mcpServers": {
    "backlog": {
      "command": "node",
      "args": [
        "build/index.js"
      ],
      "env": {
        "BACKLOG_DOMAIN": "your-domain.backlog.com",
        "BACKLOG_API_KEY": "your-api-key"
      }
    }
  }
}

使用 Docker 安装的配置

在 Docker 运行时，可以通过以下方式挂载配置文件：

docker run -i --rm \
  -v /yourcurrentdir/mcp-config.json:/root/.backlog-mcp-serverrc.json:ro \
  ghcr.io/nulab/backlog-mcp-server

💻 使用示例

启动服务器

运行以下命令启动服务器：

node build/index.js

或者使用 Docker：

docker run -i --rm ghcr.io/nulab/backlog-mcp-server

📚 详细文档

配置文件结构

配置文件包含以下结构：

• mcpServers：定义 MCP 服务器。
  • backlog：包含以下属性：
    • command：执行命令（如：node、docker）。
    • args：命令参数数组。
    • env：环境变量，包含必填项：
      • BACKLOG_DOMAIN：Backlog 域名。
      • BACKLOG_API_KEY：Backlog API 密钥。

配置示例

以下是一个完整的配置示例：

{
  "mcpServers": {
    "backlog": {
      "command": "docker",
      "args": [
        "run",
        "-i",
        "--rm",
        "-e", "BACKLOG_DOMAIN",
        "-e", "BACKLOG_API_KEY",
        "ghcr.io/nulab/backlog-mcp-server"
      ],
      "env": {
        "BACKLOG_DOMAIN": "your-domain.backlog.com",
        "BACKLOG_API_KEY": "your-api-key"
      }
    }
  }
}

环境变量

环境变量优先级高于配置文件，可以通过以下方式设置：

docker run -i --rm \
  -e BACKLOG_DOMAIN=your-domain.backlog.com \
  -e BACKLOG_API_KEY=your-api-key \
  ghcr.io/nulab/backlog-mcp-server

描述覆盖

通过创建 .backlog-mcp-serverrc.json 文件可以覆盖工具描述：

{
  "TOOL_ADD_ISSUE_COMMENT_DESCRIPTION": "评论工具的中文描述",
  "TOOL_CREATE_PROJECT_DESCRIPTION": "项目创建工具的中文描述"
}

导出当前翻译

运行以下命令导出当前翻译：

node build/index.js --exportTranslations

国际化设置

支持 .json、.yaml 和 .yml 格式的国际化文件。

示例 YAML 文件

translation:
  key1: "value1"
  key2: "value2"

🔧 技术细节

开发和测试

添加新工具

在 commands 目录下创建新命令文件，例如：

const Command = require('@backlog/mcp-server').Command;

class MyCommand extends Command {
  // 定义你的命令逻辑
}

module.exports = MyCommand;

测试

使用 Mocha 进行测试，安装依赖后运行：

npm test

帮助信息

运行以下命令获取帮助信息：

node build/index.js --help

以上是 Backlog MCP Server 的完整中文文档。