使用说明
Backlog MCP 服务器
Backlog API 访问权限MCP 服务器。可提供项目管理、课题跟踪、文件操作等功能。
机能
- 项目管理:获取项目列表,查看详细信息
- 课题管理:创建、更新、搜索和添加问题
- 用户管理:获取用户信息
- 文件操作:管理附件
- 注释功能:添加对课题的注释
- 検索机能:查找问题和项目
工具
项目关系
getSpaces
- 获取空间信息
- 输入:无
- 返回值:空间信息
get项目
- 获取项目列表
- 输入:无
- 返回值:项目列表
课题关连
获取问题
- 获取课题列表
- 入力:
- projectIdOrKey (string): 项目名称ID 或键
- offset (number, 可选:获取开始位置
- count (number, 可选:获取次数(最多100个)
- sort (string, 可选:排序顺序('created'或'updated')
- order (string, 可选:排序方向(“asc”或“desc')
- 返回值:课题一览
getIssue
- 获取课题的详细信息
- 入力:
- issueIdOrKey (string): 挑战ID 或键
- 返回值:问题详细信息
createIssue
- 创建新课题
- 入力:
- projectId (string/number): 项目名称ID
- 摘要(字符串):課題の件名
- issueTypeId(字符串/数字):課題種別 ID
- priorityId (string/number, 可选:优先级ID
- description (string, 可选:问题详细信息
- startDate (string, 可选:开始日期(YYYY-MM-DD格式)
- dueDate (string, 可选:到期日(YYYY-MM-DD格式)
- assigneeId (string/number, 可选:联系人ID
- 返回值:创建的问题信息
updateIssue
- 更新现有问题
- 入力:
- issueIdOrKey (string): 挑战ID 或键
- summary (string, 可选:问题主题
- description (string, 可选:问题详细信息
- statusId (string/number, 可选:状态ID
- priorityId (string/number, 可选:优先级ID
- assigneeId (string/number, 可选:联系人ID
- startDate (string, 可选:开始日期(YYYY-MM-DD格式)
- dueDate (string, 可选:到期日(YYYY-MM-DD格式)
- 返回值:更新的问题信息
addComment
- 向课题添加注释
- 入力:
- issueIdOrKey (string): 挑战ID 或键
- content (string): 评论内容
- 返回值:添加的注释信息
検索关连
搜索问题
- 查找问题
- 入力:
- keyword (string): 搜索关键字
- projectIdOrKey (string, 可选:项目ID 或键
- offset (number, 可选:获取开始位置
- count (number, 可选:获取次数(最多100个)
- 返回值:搜索结果问题列表
検索构文
课题検索
keyword:查找自由文本projectId:在特定项目中缩小范围statusId:在状态下缩小assigneeId:由联系人筛选
例: keyword=バグ statusId=1 assigneeId=12345
安装,安装
API 获取密钥
- Backlog 登录
- 个人设置>API > API 提交密钥
- 已发布API 复制密钥
设置环境变量
.env将以下设置添加到文件:
BACKLOG_DOMAIN=your-domain.backlog.com
BACKLOG_API_KEY=your-api-key
# テスト用設定(オプション)
TEST_PROJECT_ID=your-test-project-id
TEST_PROJECT_KEY=your-test-project-key
Claude Desktop 在中使用
Claude Desktop 中描述的相应参数的值claude_desktop_config.json中添加以下内容:
NPX 在…的情况下
{
"mcpServers": {
"backlog": {
"command": "npx",
"args": ["-y", "@tmhr1850/backlog-mcp-server"],
"env": {
"BACKLOG_DOMAIN": "your-domain.backlog.com",
"BACKLOG_API_KEY": "your-api-key"
}
}
}
}
本地运行
# ビルド
npm run build
# 実行
npm start
测试
# 全テスト実行
npm test
# 監視モードでテスト実行
npm run test:watch
# カバレッジレポート付きでテスト実行
npm run test:coverage
许可证
这个MCP 服务器是MIT 在许可证下提供。有关详细信息,请参见项目存储库中的LICENSE 请看文件。