MCP-服务器快捷方式

Name: MCP-服务器快捷方式
Author: useshortcut

作者：useshortcut76 星标更新：2025-11-17

安装使用来源：spider==github.com

项目介绍

@shortcut/mcp

用于 Shortcut 的 MCP 服务器。

<br />

使用方法

Windsurf

更多详细信息请参阅官方 Windsurf 文档。

打开 Windsurf MCP 配置面板
点击 添加自定义服务器。
添加以下详细信息并保存文件：

{
  "mcpServers": {
    "shortcut": {
      "command": "npx",
      "args": [
        "-y",
        "@shortcut/mcp@latest"
      ],
      "env": {
        "SHORTCUT_API_TOKEN": "<YOUR_SHORTCUT_API_TOKEN>"
      }
    }
  }
}

Cursor

更多详细信息请参阅官方 Cursor 文档。

打开（或创建）mcp.json 文件（该文件应位于 ~/.cursor/mcp.json 或 <项目根目录>/.cursor/mcp.json，但请参阅 Cursor 文档以获取更多详细信息）。
添加以下详细信息并保存文件：

{
  "mcpServers": {
    "shortcut": {
      "command": "npx",
      "args": [
        "-y",
        "@shortcut/mcp@latest"
      ],
      "env": {
        "SHORTCUT_API_TOKEN": "<YOUR_SHORTCUT_API_TOKEN>"
      }
    }
  }
}

Claude Code

更多详细信息请参阅官方 Claude Code 文档。

你可以从 Claude Code CLI 添加新的 MCP 服务器。但直接修改 JSON 文件更简单！

你可以从命令行添加新的 MCP 服务器：

# 在此处获取你的 Shortcut 令牌：https://app.shortcut.com/settings/account/api-tokens
claude mcp add shortcut --transport=stdio -e SHORTCUT_API_TOKEN=$SHORTCUT_API_TOKEN -- npx -y @shortcut/mcp@latest

或者你可以直接编辑本地 JSON 文件：

打开 Claude Code 配置文件（该文件应位于 ~/.claude.json）。
找到 projects > mcpServers 部分并添加以下详细信息并保存文件：

{
  "projects": {
    "mcpServers": {
      "shortcut": {
        "command": "npx",
        "args": [
          "-y",
          "@shortcut/mcp@latest"
        ],
        "env": {
          "SHORTCUT_API_TOKEN": "<YOUR_SHORTCUT_API_TOKEN>"
        }
      }
    }
  }
}

Zed

Zed MCP 文档

打开你的 settings.json 文件。操作指南在此
添加以下详细信息并保存文件：

  "context_servers": {
    "shortcut": {
      "settings":{},
      "command": {
        "path": "<PATH/TO/NPX>",
        "args": [
          "-y",
          "@shortcut/mcp@latest"
        ],
        "env": {
          "SHORTCUT_API_TOKEN": "<YOUR_SHORTCUT_API_TOKEN>"
        }
      }
    }
  }

可用工具

故事

stories-get-by-id - 通过 ID 获取单个 Shortcut 故事
stories-search - 使用过滤和搜索选项查找 Shortcut 故事
stories-get-branch-name - 获取特定故事的推荐分支名称（基于工作区设置）
stories-create - 创建新的 Shortcut 故事
stories-update - 更新现有的 Shortcut 故事
stories-upload-file - 上传文件并将其链接到故事
stories-assign-current-user - 将当前用户分配为故事的所有者
stories-unassign-current-user - 取消将当前用户分配为故事的所有者
stories-create-comment - 在故事上创建评论
stories-add-task - 向故事中添加任务
stories-update-task - 更新故事中的任务
stories-add-relation - 添加故事关系（相关于、阻止、重复等）
stories-add-external-link - 向 Shortcut 故事中添加外部链接
stories-remove-external-link - 从 Shortcut 故事中移除外部链接
stories-set-external-links - 用一组新链接替换故事上的所有外部链接
stories-get-by-external-link - 查找包含特定外部链接的所有故事

史诗

epics-get-by-id - 通过 ID 获取 Shortcut 史诗
epics-search - 使用过滤和搜索选项查找 Shortcut 史诗
epics-create - 创建新的 Shortcut 史诗

迭代

iterations-get-stories - 通过迭代 ID 获取特定迭代中的故事
iterations-get-by-id - 通过 ID 获取 Shortcut 迭代
iterations-search - 使用过滤和搜索选项查找 Shortcut 迭代
iterations-create - 创建具有开始/结束日期的新 Shortcut 迭代
iterations-get-active - 根据团队成员资格获取当前用户的活跃迭代
iterations-get-upcoming - 根据团队成员资格获取当前用户的即将进行的迭代

目标

objectives-get-by-id - 通过 ID 获取 Shortcut 目标
objectives-search - 使用过滤和搜索选项查找 Shortcut 目标

团队

teams-get-by-id - 通过 ID 获取 Shortcut 团队
teams-list - 列出所有 Shortcut 团队

工作流

workflows-get-default - 获取特定团队或工作区默认的工作流
workflows-get-by-id - 通过 ID 获取 Shortcut 工作流
workflows-list - 列出所有 Shortcut 工作流

用户

users-get-current - 获取当前用户信息
users-get-current-teams - 获取当前用户所属的团队列表
users-list - 获取所有工作区用户

文档

documents-create - 在 Shortcut 中创建带有 HTML 内容的新文档

限制工具

你可以通过设置 SHORTCUT_TOOLS 环境变量来限制 LLM 可用的工具，该变量是一个逗号分隔的列表。

可以通过仅添加实体类型来限制工具，例如 stories 或 epics。
也可以通过其完整名称来限制个别工具，例如 stories-get-by-id 或 epics-search。

默认情况下，所有工具都是启用的。

示例：

{
  "mcpServers": {
    "shortcut": {
      "command": "npx",
      "args": [
        "-y",
        "@shortcut/mcp@latest"
      ],
      "env": {
        "SHORTCUT_API_TOKEN": "<YOUR_SHORTCUT_API_TOKEN>",
        "SHORTCUT_TOOLS": "stories,epics,iterations-create"
      }
    }
  }
}

除了上述可用工具中列出的完整工具名称外，还接受以下值：

users
stories
epics
iterations
objectives
teams
workflows
documents

只读模式

你可以通过将 SHORTCUT_READONLY 环境变量设置为 true 来以只读模式运行 MCP 服务器。这将禁用所有修改 Shortcut 数据的工具。

示例：

{
  "mcpServers": {
    "shortcut": {
      "command": "npx",
      "args": [
        "-y",
        "@shortcut/mcp@latest"
      ],
      "env": {
        "SHORTCUT_API_TOKEN": "<YOUR_SHORTCUT_API_TOKEN>",
        "SHORTCUT_READONLY": "true"
      }
    }
  }
}

问题和故障排除

在执行其他操作之前，请确保你正在运行最新版本！

如果你在使用此 MCP 服务器时遇到问题，有几种选择：

在 GitHub 上提交问题
在社区 Slack 中寻求帮助

你还可以查看下面列出的常见问题，看看是否有已知的解决方案。

常见问题及解决方案

使用 MISE 进行版本管理时 NPX 命令无法正常工作

如果你使用 MISE 管理 Node 和 NPM 版本，尝试运行 MCP 服务器时可能会遇到“客户端关闭”错误。安装此扩展到你的 IDE 可能会有所帮助：https://github.com/hverlin/mise-vscode/。

开发

安装

npm install

构建

npm run build

本地运行开发服务器

要测试你的本地开发版本的 MCP 服务器而不是使用发布的包，请按照以下步骤操作：

构建项目：
```
npm run build
```

创建或修改你的 mcp.json 文件以引用你的本地构建：

{
  "mcpServers": {
    "shortcut": {
      "command": "node",
      "args": [
        "/path/to/your/local/mcp-server-shortcut/dist/index.js"
      ],
      "env": {
        "SHORTCUT_API_TOKEN": "<YOUR_SHORTCUT_API_TOKEN>"
      }
    }
  }
}

将此 mcp.json 文件放置在以下位置之一：
- 对于 Cursor：在你的主目录 (~/.cursor/mcp.json) 或项目目录 (.cursor/mcp.json)
- 对于 Windsurf：使用 MCP 配置面板添加自定义服务器
重启你的 AI 助手（Cursor 或 Windsurf）以加载新的配置。

这允许你在不发布新版本的情况下立即测试对 MCP 服务器的更改。