mcp-backlog-server

Backlog MCP 服务器

这是一个基于 TypeScript 的服务器，用于集成 Backlog 和模型上下文协议 (MCP)。它实现了以下 MCP 的主要概念：

• 代表 Backlog 项目的资源（包括 URI 和元数据）
• 用于与 Backlog API 交互的工具
• 用于生成 Backlog 数据摘要和分析的提示

功能

资源

• 通过 backlog://project/[id] URI 访问 Backlog 项目
• 每个项目资源都包含项目的元数据和详细信息
• 用于结构化数据访问的 JSON 格式资源
• 访问项目中的问题（Issue）
• 访问项目中的 Wiki 页面

工具

• get_backlog_user - 获取当前 Backlog 用户信息
• get_backlog_space - 获取 Backlog 空间信息
• list_recent_projects - 列出最近浏览的 Backlog 项目
  • 可以设置件数和排序方式
• get_project_issues - 获取项目的问题
  • 可以通过状态、负责人、分页等进行过滤
• get_issue_detail - 获取特定问题的详细信息
• get_issue_comments - 获取问题的评论
• add_issue_comment - 向问题添加评论
• get_issue_comment_count - 获取问题的评论数
• get_issue_comment - 获取特定评论的详细信息
• get_wiki_page_list - 获取 Wiki 页面列表
  • 可以通过项目或关键字进行过滤
• get_wiki_page - 获取特定 Wiki 页面的详细信息
• update_wiki_page - 更新 Wiki 页面

提示

• summarize_projects - 生成最近浏览的 Backlog 项目的摘要
• analyze_backlog_usage - 基于用户、空间和项目数据分析 Backlog 使用模式
• summarize_wiki_pages - 生成项目的 Wiki 页面的摘要

必要条件

• 具有 API 访问权限的 Backlog 账户
• 环境变量:
  • BACKLOG_API_KEY: Backlog API 密钥
  • BACKLOG_SPACE_URL: Backlog 空间 URL (例如: https://your-space.backlog.com)

开发

安装依赖:

npm install

构建服务器:

npm run build

自动重新构建进行开发:

npm run watch

安装

要在 Claude Desktop 中使用，请添加服务器配置:

MacOS: ~/Library/Application Support/Claude/claude_desktop_config.json Windows: %APPDATA%/Claude/claude_desktop_config.json

{
  "mcpServers": {
    "mcp-backlog-server": {
      "command": "/path/to/mcp-backlog-server/build/index.js",
      "env": {
        "BACKLOG_API_KEY": "your-api-key",
        "BACKLOG_SPACE_URL": "https://your-space.backlog.com"
      }
    }
  }
}

调试

由于 MCP 服务器通过标准输入/输出进行通信，因此调试可能比较困难。建议使用 MCP Inspector。它作为包脚本提供:

npm run inspector

Inspector 将提供一个 URL，用于在浏览器中访问调试工具。

技术细节

该服务器由以下主要组件组成:

• index.ts - 主入口点，MCP 服务器的初始化和配置
• backlog-client.ts - 处理与 Backlog API 通信的客户端
• handlers/ - 资源、工具和提示的处理程序
  • resource-handlers.ts - 项目、问题和 Wiki 的资源处理
  • tool-handlers.ts - 与 Backlog API 交互的工具
  • prompt-handlers.ts - 提示生成功能
• types.ts - Backlog API 响应的类型定义
• config.ts - 从环境变量加载配置