Backlog MCP Server 61l

🚀 Backlog-MCP Server Tool

Backlog-MCP Server is a powerful tool that enables users to quickly create projects, manage issues, update wikis, store files, and integrate with other systems.

🚀 Quick Start

Tool Overview

• Project Creation: You can use the backlog-MCP server to quickly create new projects.
• Issue Tracking: The tool supports batch importing and managing issues via CSV files or direct API requests.
• Wiki Management: It can import and update Wiki content through CSV files or REST APIs.
• File Storage: It provides the function of uploading files to Backlog and supports managing the uploaded files.
• Integrated Development: The tool offers rich interfaces for developers to facilitate in - depth integration with other systems.

Configuration Example

Here is an example configuration for running the backlog-MCP server using Docker:

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

If you need to customize the configuration, you can refer to the following JSON - formatted configuration file:

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

Internationalization (i18n) of Tool Descriptions

To meet different language requirements, you can customize tool descriptions. Here are the specific methods:

Using Configuration Files

Create or modify the .backlog-mcp-serverrc.json file in your user's home directory and add the following content to override tool descriptions:

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

Supported file formats include: .json, .yaml, and .yml.

Using Environment Variables

You can also override tool descriptions by setting environment variables. For example:

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

These environment variables need to be prefixed with BACKLOG_MCP_ and use uppercase letters.

Development Guide

Running Tests

npm test

Adding New Tools

1. Create a new tool file in the src/tools/ directory, following the naming convention of existing tools.
2. Create the corresponding test file.
3. Add the new tool to the src/tools/tools.ts file.
4. Build and test your changes.

Command - Line Options

• --export-translations: Export all translation keys and values.
• --optimize-response: Enable GraphQL - style field selection.
• --max-tokens=NUMBER: Set the maximum token limit for the response.

Example:

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

License

This project is licensed under the MIT License.

⚠️ Important Note

This tool is provided under the MIT License without any warranty or official support. Please evaluate its suitability before use. If you encounter any problems, please report them via GitHub Issues.