Backlog集成服务器

一个基于TypeScript的服务器,用于集成Backlog和Model Context Protocol (MCP),提供资源访问、API交互工具和数据摘要生成功能。

  • by katsuhirohonda
  • TypeScript
  • 本地部署
  • 1 星标
  • 更新于
在 GitHub 查看 katsuhirohonda/mcp-backlog-server

使用说明

mcp积压服务器

积压的MCP服务器

这是Backlog打开Model Context Protocol (MCP)合并TypeScript基本服务器。以下MCP的主要概念:

  • Backlog表示项目的资源(包括URI和元数据)
  • Backlog API对话工具
  • Backlog提示生成数据摘要和分析

机能

资源

  • backlog://project/[id] URI通过,通过Backlog访问项目
  • 每个项目资源包含项目元数据和详细信息
  • 用于结构化数据访问JSON格式资源
  • 访问项目中的问题
  • 在动态输入提示中单击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 窗户: %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检查员中所述修改相应参数的值。它可用作包脚本:

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 -积压APIレスポンスの型定義
  • config.ts -从环境变量读取设置