@shortcutmcp

🚀 MCP 服务器 - Shortcut

MCP 服务器 - Shortcut 提供了在不同代码编辑工具中配置 Shortcut MCP 服务器的方法，帮助用户更好地集成相关功能。以下将详细介绍其使用方法、问题排查以及开发相关内容。

🚀 快速开始

✨ 主要特性

• 支持在 Windsurf、Cursor 和 Claude Code 等多种代码编辑工具中配置使用。
• 提供详细的使用步骤和问题排查方案。
• 支持本地开发和测试。

📦 安装指南

开发环境安装

npm install

💻 使用示例

Windsurf

有关官方 Windsurf 文档，请参阅 官方 Windsurf 文档 以获取更多详细信息。

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

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

Cursor

有关官方 Cursor 文档，请参阅 官方 Cursor 文档 以获取更多详细信息。

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

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

Claude Code

有关官方 Claude Code 文档，请参阅 官方 Claude Code 文档 以获取更多详细信息。 可以直接修改 JSON 文件更简单！

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

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

🔧 技术细节

构建项目

npm run build

在本地运行开发服务器

要测试您本地开发版本的 MCP 服务器，而不是官方发布的版本，请执行以下步骤：

1. 克隆仓库并安装依赖项：

git clone https://github.com/useshortcut/mcp-server-shortcut.git
cd mcp-server-shortcut
npm install

2. 在项目根目录中创建一个 config.json 文件，并添加以下内容（将 <YOUR_API_KEY> 替换为您的 API 密钥）：

{
  "apiKey": "<YOUR_API_KEY>",
  "apiHost": "https://api.shortcut.com"
}

3. 在终端中运行开发服务器：

npm run dev

配置 mcp.json 文件

在您的项目根目录中，创建或修改 mcp.json 文件以包含以下内容：

{
  "development": {
    "servers": [
      {
        "name": "shortcut",
        "url": "http://localhost:3001"
      }
    ]
  }
}

然后在终端中运行：

mcp init

这将初始化您的 MCP 环境并准备就绪。

📚 详细文档

问题和故障排除

在执行任何操作之前，请确保您正在运行最新版本！ 如果在使用此 MCP 服务器时遇到问题，您有几个选择：

• 在 GitHub 上打开一个问题。
• 在社区 Slack 中寻求帮助。 您还可以检查以下已知解决方案的 常见问题和解答。

常见问题及解决方案

使用 MISE 管理 Node 和 NPM 版本时 NPX 命令无法正常工作

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