🚀 Backlog MCP 服务器
这是一个集成 Backlog API 的 MCP 服务器实现，可帮助用户更便捷地与 Backlog 进行交互，实现项目、问题和维基等信息的管理操作。
🚀 快速开始
本服务器集成了 Backlog API，支持项目、问题和维基等信息的获取、添加、更新和删除操作。使用前需完成 API 密钥的获取和环境变量的配置。
✨ 主要特性
项目 API
- backlog_get_projects：可带分页和过滤器执行项目获取操作。
- backlog_get_project：能使用项目 ID 或键执行项目获取操作。
问题 API
- backlog_get_issues：支持带分页和过滤器执行问题获取操作。
- backlog_get_issue：可使用问题 ID 或键执行问题获取操作。
- backlog_add_issue：能使用问题数据执行问题添加操作。
- backlog_update_issue：可使用问题数据执行问题更新操作。
- backlog_delete_issue：能使用问题 ID 或键执行问题删除操作。
Wiki API
- backlog_get_wikis：可带关键词执行维基获取操作。
- backlog_get_wiki：能使用维基 ID 或键执行维基获取操作。
- backlog_add_wiki：可使用维基数据执行维基添加操作。
- backlog_update_wiki：能使用维基数据执行维基更新操作。
- backlog_delete_wiki：可使用维基 ID 或键执行维基删除操作。
📦 安装指南
获取 API 密钥
环境变量
此服务器需要以下环境变量：
- 必填：
BACKLOG_API_KEY：您的 Backlog API 密钥。BACKLOG_SPACE_ID：您的 Backlog 空间 ID。
- 可选：
BACKLOG_BASE_URL：您的 Backlog 基础 URL（默认：https://{your-space-id}.backlog.com/api/v2）。
与 Claude Desktop 使用
将此内容添加到您的 claude_desktop_config.json 中：
NPX
{
"mcpServers": {
"backlog": {
"command": "npx",
"args": [
"-y",
"backlog-mcp-server"
],
"env": {
"BACKLOG_API_KEY": "YOUR_API_KEY_HERE",
"BACKLOG_SPACE_ID": "YOUR_SPACE_ID_HERE"
}
}
}
}
Docker
{
"mcpServers": {
"backlog": {
"command": "docker",
"args": [
"run",
"-i",
"--rm",
"-e",
"BACKLOG_API_KEY=YOUR_API_KEY_HERE",
"-e",
"BACKLOG_SPACE_ID=YOUR_SPACE_ID_HERE",
"mcp/backlog"
],
"env": {
"BACKLOG_API_KEY": "YOUR_API_KEY_HERE",
"BACKLOG_SPACE_ID": "YOUR_SPACE_ID_HERE"
}
}
}
}
开发环境安装与构建
安装
npm install
构建
npm run build
调试
npm run debug
Docker 构建
docker build -t mcp/backlog .
💻 使用示例
基础用法
在开发环境中，可按以下步骤操作：
- 安装依赖：
npm install
- 构建项目：
npm run build
- 启动调试：
npm run debug
高级用法
扩展服务器
要扩展服务器，请按照以下步骤操作：
- 定义 Zod 模式：在
schema.ts文件中为每个工具定义相应的 Zod 模式。 - 实现工具逻辑：在
commands文件夹中创建对应命令的处理函数，例如get_projects.command.ts或add_issue.command.ts。 - 注册工具：在
index.ts文件中注册您的工具，确保它们可供使用。
通过这些步骤，您可以轻松扩展服务器以支持更多功能。
运行测试
运行测试的具体步骤待定。