使用说明

项目简介

'mcp-server-shortcut' 是一个基于 Model Context Protocol (MCP) 构建的服务器，它作为 Shortcut API 的桥梁，允许 LLM 客户端通过标准化的 MCP 协议与 Shortcut 项目管理工具进行交互。该服务器提供了一系列工具，使 LLM 能够查询和操作 Shortcut 中的故事、用户、团队、工作流等资源。

主要功能点

资源访问: 提供对 Shortcut 项目管理工具中各种资源（如故事、用户、团队、工作流、迭代、目标等）的查询能力。
工具集成: 注册并提供了一系列工具，允许 LLM 客户端调用 Shortcut API 的功能，例如创建故事、搜索故事、获取用户信息等。
标准化接口: 通过 MCP 协议与客户端通信，提供标准化的 JSON-RPC 接口。

安装步骤

安装 Bun (如果尚未安装)。
克隆或下载此仓库。
在仓库根目录下，运行 'bun install' 安装依赖。
运行 'bun run build' 构建项目。

服务器配置

MCP 客户端需要配置以下信息以连接到 'mcp-server-shortcut' 服务器。以下是 JSON 格式的配置示例，您需要根据实际情况修改路径和 API Token。

{
  "mcpServers": {
    "shortcut": {
      "command": "node",
      "args": [
        "/path/to/this/repo/shortcut-mcp"  //  请替换为仓库中 shortcut-mcp 脚本的实际路径
      ],
      "env": {
        "SHORTCUT_API_TOKEN": "<YOUR_SHORTCUT_API_TOKEN>" // 请替换为您的 Shortcut API Token
      }
    }
  }
}

参数说明:

'server name': 服务器名称，例如 "shortcut"。
'command': 启动服务器的命令，这里使用 'node'。
'args': 传递给命令的参数，指向 'shortcut-mcp' 脚本的路径。
'env': 环境变量配置，'SHORTCUT_API_TOKEN' 用于设置 Shortcut API 访问令牌。

基本使用方法

配置 MCP 客户端（例如 Windsurf 或 Cursor），添加自定义 MCP 服务器，并填入上述服务器配置信息。
在 MCP 客户端中，可以使用预定义的工具与 Shortcut 进行交互。例如，可以使用 'search-stories' 工具搜索故事，或使用 'get-story' 工具获取特定故事的详细信息。具体工具列表和使用方法请参考仓库中 'src/tools' 目录下的文件。

关键词