> ## Documentation Index
> Fetch the complete documentation index at: https://veryfront.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Shortcut

> Manage stories, epics, and workflows in Shortcut

## At a glance

* **Availability**: Experimental ([how to enable](/cloud/integrations)).
* **Auth**: API key.
* **Connection**: The key from `SHORTCUT_API_TOKEN` is sent as the `Shortcut-Token` header.
* **Docs**: [https://developer.shortcut.com/api/rest/v3](https://developer.shortcut.com/api/rest/v3)

## Credentials

Set these per environment. See [Connect an integration](/cloud/integrations).

| Variable             | Required | Description                                                                                                             |
| -------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------- |
| `SHORTCUT_API_TOKEN` | Yes      | Shortcut API token (Settings > Account > API Tokens) [Docs](https://developer.shortcut.com/api/rest/v3#Authentication). |

## Setup

1. **Sign in to Shortcut**: Go to [https://app.shortcut.com](https://app.shortcut.com) and sign in. A free trial workspace is sufficient for testing.
2. **Generate an API token**: Open Settings > Account > API Tokens ([https://app.shortcut.com/settings/account/api-tokens](https://app.shortcut.com/settings/account/api-tokens)), name the token, and generate it. Tokens are scoped to the workspace you create them in.
3. **Set the environment variable**: Add the token to your .env as SHORTCUT\_API\_TOKEN=...
4. **Verify access**: Run List Workflows, then Search Stories with a simple query.

* Shortcut authenticates with a 'Shortcut-Token' header, not Authorization
* Creating stories needs a workflow\_state\_id - call List Workflows first
* Rate limit is 200 requests per minute

Provider API reference: [https://developer.shortcut.com/api/rest/v3](https://developer.shortcut.com/api/rest/v3)

## Tools

| Tool           | Access | Description                                                             |
| -------------- | ------ | ----------------------------------------------------------------------- |
| Search Stories | Read   | Search Shortcut stories with the Shortcut search syntax                 |
| Get Story      | Read   | Get a Shortcut story by its public ID                                   |
| Create Story   | Write  | Create a new story in Shortcut                                          |
| Update Story   | Write  | Update an existing Shortcut story                                       |
| List Epics     | Read   | List epics in the Shortcut workspace                                    |
| List Members   | Read   | List members of the Shortcut workspace (use member UUIDs as owner\_ids) |
| List Workflows | Read   | List workflows and their states (use state IDs as workflow\_state\_id)  |

## Example prompts

* Search Shortcut for stories owned by me that are in progress and summarize them.
* Create a bug story in Shortcut with a clear title and reproduction steps.
