README
🚀 Backlog MCP 服务器
这是一个用于与 Backlog(项目管理工具)交互的模型上下文协议 (MCP) 服务器。它提供了查询和管理 Backlog 资源的功能,涵盖项目、问题、维基和用户活动等方面,能有效提升项目管理的效率和便捷性。
🚀 快速开始
在使用 Backlog MCP 服务器前,你需要确保满足一定的需求,然后进行安装和配置。配置完成后,即可与 Claude Desktop 或任何 MCP 兼容客户端一起使用。
✨ 主要特性
- 获取 Backlog 空间信息
- 列出和搜索项目
- 搜索、查看和管理问题
- 访问维基页面
- 查看用户活动和通知
- 获取用户信息
📦 安装指南
安装前提
- Node.js (v14 或更高版本)
- 带有 API 密钥的 Backlog 账户
安装步骤
# 克隆仓库
git clone https://github.com/digitalcube/advanced-backlog-mcp-server.git
cd advanced-backlog-mcp-server
# 安装依赖项
npm install
# 构建服务器
npm run build
📚 详细文档
配置说明
Claude 桌面设置
要将 Backlog MCP 服务器与 Claude Desktop 一起使用,请编辑以下配置文件:
- macOS:
~/Library/Application Support/Claude/claude_desktop_config.json - Windows:
%APPDATA%/Claude/claude_desktop_config.json
{
"mcpServers": {
"advanced-backlog-mcp-server": {
"command": "/path/to/advanced-backlog-mcp-server/build/index.js",
"env": {
"BACKLOG_DOMAIN": "your-domain.backlog.com",
"BACKLOG_API_KEY": "your-api-key"
}
}
}
}
获取命令路径
要在 command 字段中获取正确的路径,请在构建后运行以下命令:
echo "\"$(pwd)/build/index.js\""
示例:"/Users/username/development/mcp-servers/advanced-backlog-mcp-server/build/index.js"
在 macOS 上,您可以直接复制此路径到剪贴板:
echo "\"$(pwd)/build/index.js\"" | pbcopy
API 密钥设置
您可以在 Backlog 账户设置中获取您的 API 密钥。
使用方法
配置完成后,即可使用该服务器与 Claude Desktop 或任何 MCP 兼容客户端一起使用。在 Claude Desktop 中,您可以使用自然语言查询,例如:
- "显示我所有最近的问题"
- "列出我的 Backlog 空间中的所有项目"
- "查找分配给我的高优先级问题"
可用工具
该服务器提供以下工具:
list_backlog_space- 获取您的 Backlog 空间信息list_backlog_projects- 列出您 Backlog 空间中的所有项目list_backlog_recently_viewed_issues- 列出最近查看的问题search_backlog_issues- 使用各种过滤器搜索问题get_backlog_issue- 获取特定问题的详细信息list_backlog_recently_viewed_projects- 列出最近查看的项目get_backlog_project- 获取特定项目的详细信息list_backlog_recently_viewed_wikis- 列出最近查看的维基页面get_backlog_wiki- 获取特定维基的详细信息list_backlog_recent_user_activities- 列出特定用户的活动get_backlog_current_user- 获取当前用户的信息get_backlog_user- 获取特定用户的信息list_backlog_users- 列出您 Backlog 空间中的所有用户list_backlog_own_notifications- 列出当前用户的通知
调试方法
要调试 MCP 服务器,可以运行以下命令:
npm run inspector
然后在浏览器中访问生成的 URL。
📄 许可证
本项目使用 MIT 许可证。
微信扫一扫