Shortcut.com MCP Server

by WynnD

238 downloads
Not rated
GitHub

About

An implementation of the Model Context Protocol (MCP) server that allows Claude and other MCP-compatible AI assistants to interact with Shortcut.com’s ticket management system. It enables listing, searching, creating, updating stories, and adding comments, as well as retrieving…

Details

Author
WynnD
Downloads
238
Categories
Productivity, Project Management

- List and search stories (tickets) in Shortcut.
- Get detailed information about specific stories.
- Create and update stories.
- Add comments to stories.
- Retrieve workflow states and projects.
- Provides pre-built bug report and feature request templates.

Setting up with Highlight

This MCP is not yet compatible with Highlight’s one-click setup. However, you can still use it with Highlight by following these steps:

  1. Download and install Highlight from highlightai.com/download
  2. Navigate to the plugins tab and select "Add Custom Plugin"
  3. Configure the plugin with the settings below
    Plugin Name Shortcut.com MCP Server
    Command (node, npx, python, etc.)

    Please refer to the README for specific instructions on how to obtain API keys or other required environment variables.

  4. Enable "Start Automatically" if you want the plugin to start when Highlight launches

From the repository

Install Python 3.10+, clone the repository, create a virtual environment, install dependencies, and set up a .env file with your Shortcut API token. Run the server with python -m src.server. To use with Claude Desktop, add the server configuration to claude_desktop_config.json with the SHORTCUT_API_TOKEN environment variable.

Claude Desktop / Cursor

Paste into your MCP client config file to install this server.

{
    "mcpServers": {
        "shortcut.com mcp server": {
            "mcp-server-shortcut": {
                "command": "uv",
                "args": [
                    "venv"
                ]
            }
        }
    }
}

McpServers

{
    "mcp-server-shortcut": {
        "command": "uv",
        "args": [
            "venv"
        ]
    }
}

Shortcut.com MCP Server

An implementation of a Model Context Protocol (MCP) server for accessing and searching tickets on Shortcut.com.

Overview

This project implements an MCP server that allows Claude and other MCP-compatible AI assistants to interact with Shortcut.com's ticket management system. With this integration, AI assistants can:

- List and search for stories (tickets) in Shortcut
- Get detailed information about specific stories
- Create new stories
- Update existing stories
- Add comments to stories
- Retrieve workflow states and projects

Prerequisites

- Python 3.10+
- Shortcut.com API token

Installation

1. Clone this repository:

   git clone https://github.com/yourusername/mcp-server-shortcut.git
cd mcp-server-shortcut

2. Create a virtual environment and install dependencies:

   # Using uv (recommended)
curl -LsSf https://astral.sh/uv/install.sh | sh # For Mac/Linux
uv venv
source .venv/bin/activate # On Mac/Linux or .venv\Scripts\activate on Windows
uv pip install -r requirements.txt

# Using pip
python -m venv venv
source venv/bin/activate # On Mac/Linux or venv\Scripts\activate on Windows
pip install -r requirements.txt

3. Create a .env file in the project root directory with your Shortcut API token:

   SHORTCUT_API_TOKEN=your_token_here
SERVER_PORT=5000
SERVER_HOST=0.0.0.0
DEBUG_MODE=True

Running the Server

Start the MCP server using:

python -m src.server

Configuring Claude Desktop

To use this MCP server with Claude Desktop:

1. Edit the Claude Desktop configuration file:
- Mac: ~/Library/Application Support/Claude/claude_desktop_config.json
- Windows: %APPDATA%\Claude\claude_desktop_config.json

2. Add the MCP server configuration:

   {
"mcpServers": {
"shortcut": {
"command": "python",
"args": ["-m", "src.server"],
"env": {
"SHORTCUT_API_TOKEN": "your_token_here"
}
}
}
}

3. Restart Claude Desktop.

Available MCP Capabilities

Resources

- shortcut://stories - Access a list of stories
- shortcut://story/{story_id} - Access a specific story

Tools

- list_stories - List stories with optional filtering
- search_stories - Search for stories using text queries
- get_story_details - Get detailed information about a specific story
- create_story - Create a new story
- update_story - Update an existing story
- add_comment - Add a comment to a story
- list_workflow_states - List all workflow states
- list_projects - List all projects

Prompts

- create_bug_report - Generate a template for bug reports
- create_feature_request - Generate a template for feature requests

Project Structure

- src/ - Source code directory
- server.py - Main MCP server implementation
- config.py - Configuration management
- shortcut_client.py - Client for the Shortcut API
- utils.py - Utility functions and data models
- requirements.txt - Project dependencies
- .env - Environment variables (not tracked in git)

Development

Adding New Capabilities

To add a new capability to the MCP server:

1. Add any new API methods to shortcut_client.py
2. Define Pydantic models in utils.py if needed
3. Implement the MCP functionality using decorators in server.py:
- Use @mcp.resource() for read-only resources
- Use @mcp.tool() for actions that can modify data
- Use @mcp.prompt() for generating templates or structured text

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

MIT License

No reviews yet — be the first

Sign in to leave a review

Use Google, GitHub, or an email account so ratings stay tied to real people.

Email sign in

No reviews posted yet.