🚀 mcp-backlog-server

这是一个将Backlog与Model Context Protocol (MCP) 相结合的TypeScript基础服务器，实现了MCP的主要概念，可通过资源管理、工具集和提示功能，有效整合Backlog的功能，并通过MCP协议实现与外部系统的交互。

🚀 快速开始

使用本项目前，需满足以下系统要求：

• 配备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

✨ 主要特性

资源管理

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

工具集

• get_backlog_user：获取当前Backlog用户信息。
• get_backlog_space：获取Backlog空间信息。
• list_recent_projects：列出最近访问的Backlog项目，支持指定数量和排序顺序。
• get_project_issues：获取项目的Issue列表，支持按状态、负责人和分页过滤。
• get_issue_detail：获取特定Issue的详细信息。
• get_issue_comments：获取Issue下的评论内容。
• add_issue_comment：向Issue添加新的评论。
• get_issue_comment_count：获取Issue的总评论数。
• get_issue_comment：获取指定评论的详细信息。
• get_wiki_page_list：获取Wiki页面列表，支持按项目或关键词过滤。
• get_wiki_page：获取特定Wiki页面的内容详情。
• update_wiki_page：更新现有Wiki页面内容。

提示功能

• summarize_projects：生成最近访问项目的摘要信息。
• analyze_backlog_usage：基于用户、空间和项目数据进行使用模式分析。
• summarize_wiki_pages：生成指定项目Wiki页面的概要信息。

📦 安装指南

安装依赖

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_here",
        "BACKLOG_SPACE_URL": "https://your-space.backlog.com"
      }
    }
  }
}

🔧 技术细节

项目结构主要由以下几个关键文件组成：

• index.ts：入口文件，负责服务器初始化和配置。
• backlog-client.ts：处理与Backlog API的通信逻辑。
• 各处理器文件（tool-handlers.ts, prompt-handlers.ts, types.ts等）：分别处理工具交互、提示生成及类型定义。
• config.ts：负责从环境变量读取配置信息。

通过以上设计，该服务器能够有效整合Backlog的功能，并通过MCP协议实现与外部系统的交互。