backlog-mcp-server-61l

🚀 backlog - MCP 服务器工具

backlog - MCP 服务器工具是一款功能强大的项目管理辅助工具，它能帮助用户快速创建项目、高效管理问题和 Wiki 内容，还支持文件存储和集成开发。同时，工具提供了灵活的配置方式和国际化支持，满足不同用户的多样化需求。

🚀 快速开始

您可以使用 backlog - MCP 服务器快速创建新的项目，还能利用其丰富功能对项目进行管理和开发。

✨ 主要特性

• 创建项目：您可以使用 backlog - MCP 服务器快速创建新的项目。
• 问题跟踪：该工具支持通过 CSV 文件或直接 API 请求批量导入和管理问题。
• Wiki 管理：能够通过 CSV 文件或 REST API 导入和更新 Wiki 内容。
• 文件存储：提供将文件上传到 Backlog 的功能，并且支持对上传的文件进行管理。
• 集成开发：该工具为开发者提供了丰富的接口，方便与其他系统进行深度集成。

📦 安装指南

以下是使用 Docker 运行 backlog - MCP 服务器的示例配置：

docker run -i --rm ghcr.io/nulab/backlog-mcp-server node build/index.js

如果您需要自定义配置，可以参考以下 JSON 格式的配置文件：

{
  "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"
      }
    }
  }
}

💻 使用示例

基础用法

工具描述的国际化 - 使用配置文件

在您的用户主目录下创建或修改 .backlog-mcp-serverrc.json 文件，添加以下内容以覆盖工具描述：

{
  "TOOL_ADD_ISSUE_COMMENT_DESCRIPTION": "添加问题评论",
  "TOOL_CREATE_PROJECT_DESCRIPTION": "创建新项目"
}

支持的文件格式包括：.json、.yaml 和 .yml。

工具描述的国际化 - 使用环境变量

您还可以通过设置环境变量来覆盖工具描述，例如：

BACKLOG_MCP_TOOL_ADD_ISSUE_COMMENT_DESCRIPTION=添加问题评论
BACKLOG_MCP_TOOL_CREATE_PROJECT_DESCRIPTION=创建新项目

这些环境变量需要以 BACKLOG_MCP_ 为前缀，并且使用大写字母。

高级用法

运行测试

npm test

添加新工具

1. 在 src/tools/ 目录下创建新的工具文件，遵循现有工具的命名规范。
2. 创建对应的测试文件。
3. 将新工具添加到 src/tools/tools.ts 文件中。
4. 构建并测试您的更改。

命令行选项使用

• --export-translations：导出所有翻译键和值
• --optimize-response：启用 GraphQL 风格字段选择
• --max-tokens=NUMBER：设置响应的最大令牌限制

示例：

node build/index.js --optimize-response --max-tokens=100000

📚 详细文档

工具描述的国际化（i18n）

为了满足不同语言需求，您可以自定义工具描述。具体方法如下：

• 使用配置文件：在您的用户主目录下创建或修改 .backlog-mcp-serverrc.json 文件，添加相应内容以覆盖工具描述，支持的文件格式包括：.json、.yaml 和 .yml。
• 使用环境变量：通过设置以 BACKLOG_MCP_ 为前缀且使用大写字母的环境变量来覆盖工具描述。

开发指南

运行测试

使用 npm test 命令运行测试。

添加新工具

按以下步骤添加新工具：

1. 在 src/tools/ 目录下创建新的工具文件，遵循现有工具的命名规范。
2. 创建对应的测试文件。
3. 将新工具添加到 src/tools/tools.ts 文件中。
4. 构建并测试您的更改。

命令行选项

• --export-translations：导出所有翻译键和值
• --optimize-response：启用 GraphQL 风格字段选择
• --max-tokens=NUMBER：设置响应的最大令牌限制

📄 许可证

本项目遵守 MIT 许可证。

⚠️ 重要提示

此工具在 MIT 许可证下提供，不带任何保证或官方支持。使用前请自行评估其适用性。如遇问题，请通过 GitHub Issues 报告。