项目简介
'mcp-servers' 仓库提供了一个 TUI 工具,用于简化 MCP 服务器的安装和配置。 其中 '@madisonbullard/shortcut-mcp-server' 包是一个预构建的 MCP 服务器,专门用于连接到 Shortcut 项目管理工具。 该服务器允许 LLM 客户端通过标准 MCP 协议访问和检索 Shortcut 中的项目数据,例如故事 (Stories)、史诗 (Epics) 和目标 (Objectives)。
主要功能点
- 资源访问: 提供对 Shortcut 故事 (Stories)、史诗 (Epics) 和目标 (Objectives) 的数据访问能力。
- 工具注册: 注册 'get-story', 'get-epic', 'get-objective' 等工具,允许 LLM 客户端通过 ID 获取 Shortcut 平台上的项目信息。
- Prompt 模板: 虽然仓库描述中没有明确提及 Prompt 模板,但作为 MCP 服务器,它为 LLM 客户端提供结构化的上下文数据,可以用于构建自定义 Prompt。
- JSON-RPC 协议: 使用 MCP 协议标准 JSON-RPC 通信。
- Stdio 传输协议: 支持 Stdio 传输协议。
安装步骤
- 安装 Bun: 确保已安装 Bun 包管理器 (https://bun.sh/)。
- 克隆仓库: 'git clone https://github.com/madisonbullard/mcp-servers'
- 进入仓库目录: 'cd mcp-servers'
- 安装依赖: 'bun install'
- 构建 Shortcut MCP 服务器: 'bun run build' (此命令会构建所有包,或者可以进入 'packages/shortcut-mcp-server' 目录运行 'bun run build')
- 安装 Shortcut MCP 服务器: 可以使用仓库提供的 TUI 工具进行安装,具体参考仓库 README 或 '@madisonbullard/mcp-server-tui' 包的说明。 也可以手动复制 'packages/shortcut-mcp-server/dist' 目录到合适位置。
服务器配置
MCP 客户端需要配置以下 JSON 信息以启动 Shortcut MCP 服务器:
{ "serverName": "shortcut", "command": "node", "args": [ "<服务器可执行文件路径>/server.js" ], "env": { "SHORTCUT_API_TOKEN": "<你的 Shortcut API Token>" } }
- 'serverName': 服务器名称,设置为 "shortcut"。
- 'command': 启动服务器的命令,通常为 "node"。
- 'args': 命令参数,指向 'server.js' 文件的路径。需要将 '<服务器可执行文件路径>' 替换为实际的 'server.js' 文件路径,例如:'/path/to/mcp-servers/packages/shortcut-mcp-server/dist'
- 'env': 环境变量配置。
- 'SHORTCUT_API_TOKEN': 必须配置 Shortcut API Token,用于服务器访问 Shortcut API。请在 Shortcut 平台生成 API Token 并替换 '<你的 Shortcut API Token>'。
基本使用方法
- 启动 Shortcut MCP 服务器 (通过 TUI 工具或手动运行 'server.js')。
- 在 MCP 客户端中配置上述服务器信息,并启用 Shortcut MCP 服务器连接。
- 在 LLM 应用中,可以使用注册的工具,例如 'get-story',并提供 Story ID 作为参数,以获取 Shortcut 故事的上下文信息。
信息
分类
生产力应用