@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/。