@shortcut/mcp

@shortcut/mcp

site icon
2025.04.10 18
TypeScriptAPI 集成开发工具开发效率
mcp-server-shortcut 是一个用于与 Shortcut API 交互的 MCP(Model Context Protocol)服务器。它允许用户通过 Windsurf、Cursor 和 Claude Code 等工具与 Shortcut 服务进行集成,提供便捷的 API 访问和上下文管理功能。
View on GitHub

Overview

基本能力

产品定位

mcp-server-shortcut 是一个 MCP 服务器,主要用于与 Shortcut API 进行交互,为开发者和团队提供高效的 API 访问和上下文管理功能。

核心功能

  1. 与 Shortcut API 交互:通过 MCP 协议与 Shortcut API 进行通信,支持多种开发工具(如 Windsurf、Cursor 和 Claude Code)。
  2. 灵活的配置:支持通过 JSON 配置文件自定义 MCP 服务器参数,包括命令、参数和环境变量。
  3. 本地开发支持:允许开发者本地构建和测试 MCP 服务器,无需发布即可验证更改。

适用场景

  1. 开发工具集成:与 Windsurf、Cursor 和 Claude Code 等开发工具集成,提供 Shortcut API 访问能力。
  2. 团队协作:通过 Shortcut API 管理团队任务和项目,提升协作效率。
  3. 本地开发测试:开发者可以在本地构建和测试 MCP 服务器,快速验证功能更改。

工具列表

  1. Windsurf:通过 MCP Configuration Panel 添加自定义服务器,支持 Shortcut API 访问。
  2. Cursor:通过修改 mcp.json 文件配置 MCP 服务器,支持 Shortcut API 访问。
  3. Claude Code:通过修改 ~/.claude.json 文件配置 MCP 服务器,支持 Shortcut API 访问。

常见问题解答

  1. NPX 命令无法正常工作:如果使用 MISE 进行版本管理,可能会遇到 "Client closed" 错误。可以尝试安装 mise-vscode 扩展。
  2. 其他问题:可以访问 GitHub Issues 或加入 Slack 社区 寻求帮助。

使用教程

使用依赖

  1. 确保已安装 Node.js 和 npm。
  2. 获取 Shortcut API Token(SHORTCUT_API_TOKEN)。

安装教程

  1. 安装依赖bash npm install
  2. 构建项目bash npm run build

调试方式

  1. 本地运行开发服务器bash npm run build
  2. 修改 mcp.json 文件json { "mcpServers": { "shortcut": { "command": "node", "args": [ "/path/to/your/local/mcp-server-shortcut/dist/index.js" ], "env": { "SHORTCUT_API_TOKEN": "<YOUR_SHORTCUT_API_TOKEN>" } } } }
  3. 重启开发工具:重启 Cursor 或 Windsurf 以加载新配置。

许可证

该项目遵循 MIT 开源许可条款,请参阅 MIT 了解完整条款。