@shortcutmcp

🚀 MCP Server - Shortcut

This project provides a MCP server for Shortcut, enabling seamless integration with different code editors. It simplifies the process of setting up and using the MCP server in various development environments.

🚀 Quick Start

Windsurf

For the official Windsurf documentation, refer to Official Windsurf Documentation for more details.

1. Open the Windsurf MCP Configuration Panel.
2. Click Add Custom Server.
3. Add the following details and save the file:

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

Cursor

For the official Cursor documentation, refer to Official Cursor Documentation for more details.

1. Open (or create) the mcp.json file (it should be located at ~/.cursor/mcp.json or <Project Root>/.cursor/mcp.json, but refer to the Cursor documentation for more information).
2. Add the following details and save the file:

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

Claude Code

For the official Claude Code documentation, refer to Official Claude Code Documentation for more details. It's easier to modify the JSON file directly!

1. Open the Claude Code configuration file (it should be located at ~/.claude.json).
2. Find the projects > mcpServers section and add the following details and save the file:

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

💡 Issues and Troubleshooting

Before performing any operations, make sure you are running the latest version! If you encounter issues when using this MCP server, you have several options:

• Open an issue on GitHub.
• Seek help in the community Slack. You can also check the Common Issues and Solutions for known solutions.

Common Issues and Solutions

NPX command doesn't work when using MISE to manage Node and NPM versions

If you use MISE to manage Node and NPM versions, you may encounter a "Client closed" error when trying to run the MCP server. Installing this extension in your IDE may help: https://github.com/hverlin/mise-vscode/.

🔧 Development

Installation

npm install

Build

npm run build

Run the development server locally

To test your local development version of the MCP server instead of the official release, follow these steps:

1. Clone the repository and install the dependencies:

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

2. Create a config.json file in the project root directory and add the following content (replace <YOUR_API_KEY> with your API key):

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

3. Run the development server in the terminal:

npm run dev

Configure the mcp.json file

In your project root directory, create or modify the mcp.json file to include the following content:

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

Then run the following command in the terminal:

mcp init

This will initialize your MCP environment and get it ready.