使用说明(Markdown格式):
项目简介
本项目是一个 Model Context Protocol (MCP) 服务器,旨在将 Backlog 项目管理工具的功能集成到支持 MCP 协议的 LLM 客户端(如 Claude)中。通过此服务器,LLM 可以安全地访问和操作 Backlog 中的项目、任务、用户、Wiki 等资源,实现更智能的项目管理和工作流程自动化。
主要功能点
- 数据访问: 提供对 Backlog 项目、问题 (Issues)、用户、Wiki、文件等资源的读取能力。
- 功能执行: 支持创建、更新、删除 Backlog 中的各种资源,例如创建 Issue、更新 Wiki 页面、管理项目成员等。
- 权限控制: 支持 'READ'(只读)和 'MUTATE'(读写)两种权限模式,可以根据需要限制 LLM 客户端的访问能力。
- 工具发现: LLM 客户端可以自动发现服务器提供的所有功能(Tools),并根据工具描述和参数进行调用。
安装步骤
-
配置 Backlog API 密钥:
- 在项目根目录下创建名为 'apikey' 的文件。
- 将您的 Backlog API 密钥粘贴到 'apikey' 文件中并保存。
-
安装依赖和构建项目:
- 确保您已安装 Node.js 和 npm。
- 在项目根目录下打开终端,运行以下命令安装项目依赖:
npm install - 运行以下命令构建项目:
npm run build
服务器配置
要将此 MCP 服务器连接到 MCP 客户端,您需要配置客户端的服务器连接信息。以下是连接配置示例(JSON 格式):
{ "serverName": "Backlog", "command": "node", "args": [ "/path/to/mcp-server-backlog/dist/index.js", "--permission", "READ" ], "transport": "stdio" }
- 'serverName': 服务器名称,可以自定义,例如 "Backlog"。
- 'command': 启动服务器的命令,通常为 'node'。
- 'args': 传递给 'node' 命令的参数数组:
- '"/path/to/mcp-server-backlog/dist/index.js"': 请替换为 'dist/index.js' 文件在您本地文件系统中的绝对路径。 这是服务器的入口文件。
- '"--permission"': 指定服务器的权限级别。
- '"READ"' 或 '"MUTATE"': 权限级别,'READ' 表示只读权限(只能使用 GET 请求),'MUTATE' 表示完整权限(可以使用包括 POST, PUT, PATCH, DELETE 在内的所有请求)。根据您的需求选择合适的权限级别。
- 'transport': 通信协议,本项目使用 'stdio' (标准输入输出)。
基本使用方法
配置完成后,MCP 客户端将能够连接到此 Backlog MCP 服务器。客户端可以发现服务器提供的 "tools",每个 tool 对应一个 Backlog API 接口。
例如,客户端可以调用名为 'get-issues' 的 tool 来获取 Backlog 中的 Issue 列表,或调用 'add-issue' tool 来创建一个新的 Issue。
具体的 tool 名称、参数和功能,请参考 'src/index.ts' 文件中 'server.tool(...)' 的注册部分。这些 tool 名称可以直接在 MCP 客户端中使用。
注意:
- 请确保将 '/path/to/mcp-server-backlog' 替换为实际的项目路径。
- 首次运行服务器前,请务必配置正确的 Backlog API 密钥。
- 根据您的使用场景选择合适的权限级别 ('READ' 或 'MUTATE')。
信息
分类
开发者工具