积压的MCP服务器(mcp-backlog-server)

mcp-backlog-server 是用于与Backlog API交互的模型上下文协议(MCP)服务器。 此服务器允许MCP兼容客户端(如AI助手)利用待办事项列表功能。
安装
使用Homebrew(推荐用于macOS/Linux)
最简单的安装方式是通过Homebrew:
# Add the tap (only needed once)
brew tap safx/tap
# Install the tools
brew install mcp-backlog-server # MCP server for AI assistants
brew install blg # Backlog CLI tool (Optional)要更新到最新版本:
brew update
brew upgrade mcp-backlog-server
brew upgrade blg要卸载,请执行以下操作:
brew uninstall mcp-backlog-server
brew uninstall blg
brew untap safx/tap # Optional: remove the tap替代安装方法
对于其他平台,或者如果您不想使用Homebrew:
- 预构建二进制文件:从下载 发布页面
- 从源代码构建:克隆存储库并运行
cargo build --release
MCP客户端配置示例
克劳德桌面版
~/Library/Application Support/Claude/claude_desktop_config.json:
{
"mcpServers": {
"backlog": {
"command": "/path/to/target/release/mcp-backlog-server",
"args": [],
"env": {
"BACKLOG_BASE_URL": "https://your-space.backlog.com",
"BACKLOG_API_KEY": "YOUR_BACKLOG_API_KEY",
"BACKLOG_PROJECTS": "PROJ,DEMO",
"BACKLOG_PREFIX": "backlog_"
}
}
}
}克莱恩
将以下内容添加到Cline MCP配置中:
{
"mcpServers": {
"backlog_mcp_server": {
"autoApprove": [],
"disabled": false,
"timeout": 60,
"command": "/path/to/target/release/mcp-backlog-server",
"args": [],
"env": {
"BACKLOG_BASE_URL": "https://your-space.backlog.com",
"BACKLOG_API_KEY": "YOUR_BACKLOG_API_KEY",
"BACKLOG_PROJECTS": "PROJ,DEMO",
"BACKLOG_PREFIX": "backlog_"
},
"transportType": "stdio"
}
}
}Gemini CLI
~/.gemini/settings.json:
{
"mcpServers": {
"backlog_mcp_server": {
"command": "/path/to/target/release/mcp-backlog-server",
"timeout": 10000,
"args": [],
"env": {
"BACKLOG_BASE_URL": "https://your-space.backlog.com",
"BACKLOG_API_KEY": "YOUR_BACKLOG_API_KEY",
"BACKLOG_PROJECTS": "PROJ,DEMO",
"BACKLOG_PREFIX": "backlog_"
}
}
}
}注意:域名必须是: backlog.com, backlog.jp 或 backlogtool.com
可用工具
以下工具按其各自的模块分组:
工具摘要
使用默认配置,您可以访问 36工具 对于待办事项自动化:
- 文件 (5个工具):查看文档树、获取详细信息、下载附件、添加文档、删除文档
- Git/Pull请求 (8个工具):管理存储库、PR、评论和附件
- 问题 (12个工具):查看、创建、更新问题、管理评论、附件、共享文件和优先级
- 项目 (3个工具):获取项目状态、问题类型和自定义字段定义
- 共享文件 (2个工具):浏览和下载项目共享文件
- 用户 (1个工具):列出空间用户
- 维基 (5个工具):管理wiki页面、附件和内容更新
服务器包括两者 读取操作 用于信息收集和 写入操作 为了采取行动。
备注:工具名称跟在a后面 category_resource_action 模式(例如。, issue_details_get, wiki_update)通过以下方式启用基于类别的筛选 --allowedTools (例如。, claude --allowedTools "mcp__backlog__issue_*").
文档工具
document_details_get:检索特定待办事项列表文档的详细信息document_attachment_download:下载文档附件document_tree_get:获取指定项目的文档树document_add:向待办事项列表项目添加新文档document_delete:从待办事项列表中删除文档
Git工具
git_repository_list_get:获取指定项目的Git存储库列表git_repository_details_get:获取特定Git存储库的详细信息git_pr_list_get:获取指定存储库的拉取请求列表git_pr_details_get:获取特定拉取请求的详细信息git_pr_attachment_list_get:获取特定拉取请求的附件列表git_pr_comment_list_get:获取特定拉取请求的评论列表git_pr_attachment_download:下载拉取请求附件git_pr_comment_add:向特定的pull请求添加注释
问题工具
issue_details_get:检索特定积压问题的详细信息issue_milestone_list_get:检索指定项目的版本(里程碑)列表issue_list_by_milestone_get:检索与指定里程碑关联的问题列表issue_update:更新积压问题,包括摘要、描述和自定义字段issue_comment_list_get:获取特定问题的注释issue_attachment_list_get:获取指定问题的附件列表issue_attachment_download:下载问题附件issue_shared_file_list_get:获取链接到指定问题的共享文件列表issue_comment_update:更新关于积压问题的现有评论issue_add:在支持自定义字段的待办事项列表项目中创建新问题issue_comment_add:为特定问题添加评论issue_priority_list_get:获取空间中可用的优先级类型列表
项目工具
project_status_list_get:获取指定项目的状态列表project_issue_type_list_get:获取指定项目的问题类型列表project_custom_field_list_get:获取为指定项目定义的自定义字段列表
共享文件工具
file_shared_list_get:获取指定项目目录的共享文件列表file_shared_download:下载共享文件
用户工具
user_list_get:获取空间中的用户列表
Wiki工具
wiki_list_get:获取wiki页面列表wiki_details_get:获取特定wiki页面的详细信息wiki_attachment_list_get:获取指定wiki页面的附件列表wiki_attachment_download:从wiki页面下载附件wiki_update:更新wiki页面
文件下载功能
所有文件下载工具(document_attachment_download, issue_attachment_download, git_pr_attachment_download, wiki_attachment_download,以及 file_shared_download)支持格式检测和处理:
格式检测
- 图像:文件包含
image/*通过以下方式检测内容类型并将其作为base64编码图像返回rmcp::model::Content::image - 文本:具有文本内容类型的文件(
text/*,application/json,application/xml等)或包含有效UTF-8文本的文件作为纯文本通过以下方式返回rmcp::model::Content::text - 原始字节:所有其他文件都以JSON对象的形式返回,包含base64编码的内容、文件名和MIME类型
手动格式覆盖
您可以使用可选的 format 参数:
"image":强制处理为图像(验证内容类型)"text":强制处理为文本(验证UTF-8编码)"raw":强制处理为原始字节(无验证)
内容类型检测
系统使用多种策略来确定文件是否为文本:
- 内容类型标头分析
- UTF-8有效性检查
- 字符组成分析(图形、空格和有效的UTF-8字符)
如何构建
# Default build (includes all writable features)
cargo build --package mcp-backlog-server功能标志
MCP服务器支持多个功能标志,以启用不同的写入操作:
issue_writable(默认启用)
- 使能够: issue_update, issue_comment_update, issue_add,以及 issue_comment_add 工具 - 允许AI代理创建问题、修改问题内容和管理评论
git_writable(默认启用)
- 使能够: git_pr_comment_add 工具 - 允许AI代理添加注释以拉取请求
wiki_writable(默认启用)
- 使能够: wiki_update 工具 - 允许AI代理更新wiki页面内容、名称和通知设置
document_writable(默认启用)
- 使能够: document_add 和 document_delete 工具 - 允许AI代理创建和删除文档
生成配置
# Read-only mode (no write operations)
cargo build --package mcp-backlog-server --no-default-features
# Selective features
cargo build --package mcp-backlog-server --features issue_writable
cargo build --package mcp-backlog-server --features "issue_writable,git_writable"
cargo build --package mcp-backlog-server --features "issue_writable,git_writable,wiki_writable,document_writable"配置
要运行此服务器,必须设置以下环境变量:
BACKLOG_BASE_URL:您的待办事项列表空间的URL(例如。,https://your-space.backlog.com)BACKLOG_API_KEY:您的Backlog API密钥。您可以从待办事项列表中的个人设置页面发布一个。
可选环境变量:
BACKLOG_PROJECTS:逗号分隔的允许项目密钥列表(例如。,MFP,DEMO,TEST).设置后,服务器将只允许访问指定的项目。如果未设置,则使用API键可访问的所有项目都可用。BACKLOG_PREFIX:工具名称的自定义前缀(默认值:backlog_).例如,设置BACKLOG_PREFIX=""删除前缀,使工具可按以下方式访问issue_details_get而不是backlog_issue_details_get.设置BACKLOG_PREFIX="my_"将工具更改为my_issue_details_get.
这些环境变量预计将在启动服务器时由MCP客户端系统传递。
运行(用于本地测试)
设置环境变量后,您可以使用以下命令直接运行服务器:
# Default run with all features
BACKLOG_BASE_URL="https://your-space.backlog.com" \
BACKLOG_API_KEY="your_backlog_api_key" \
cargo run --package mcp-backlog-server