---
title: "Shortcut"
description: "Read stories, search one explicit page of stories, and inspect workflows in your Shortcut workspace. Uses your own API token; no story writes or managed OAuth."
---

> Documentation Index
> Fetch the complete documentation index at: https://help.tooluse.net/llms.txt
> Use this file to discover all available pages before exploring further.

# Shortcut

<p>Read stories, search one explicit page of stories, and inspect workflows in your Shortcut workspace. Uses your own API token; no story writes or managed OAuth.</p>

<details data-command-index><summary>What you can do (3)</summary>
<h2>What you can do</h2>
<p>Available commands: 3 (3 read, 0 write). Enable only the commands your application needs.</p>
<div class="nb-table-scroll"><table>
<thead>
<tr>
<th>Command</th>
<th>Effect</th>
</tr>
</thead>
<tbody><tr>
<td><a href="https://help.tooluse.net/integrations/shortcut#command-shortcut-stories-search">Search stories</a> — <code>shortcut.stories.search</code></td>
<td>Read</td>
</tr>
<tr>
<td><a href="https://help.tooluse.net/integrations/shortcut#command-shortcut-stories-get">Get story</a> — <code>shortcut.stories.get</code></td>
<td>Read</td>
</tr>
<tr>
<td><a href="https://help.tooluse.net/integrations/shortcut#command-shortcut-workflows-list">List workflows</a> — <code>shortcut.workflows.list</code></td>
<td>Read</td>
</tr>
</tbody></table>
</div>
</details>
<h2>Connect and use</h2>

<p><a href="https://www.tooluse.net/tools/integrations/shortcut">Connect and use</a></p>
<p>Open the integration&#39;s connection form to check the available credential source. The source has not been resolved for this documentation export. The instructions below apply when using your own provider account.</p>
<h2>Get your provider credentials</h2>
<p>Follow these steps for Shortcut, then enter the issued values in the connection form below.</p>
<ol>
<li>In Shortcut, open Settings → Account → API Tokens and generate a token for your own account. Shortcut tokens inherit your account permissions; use a dedicated account with only the workspace access you need. In Tooluse.net, open Tools → Shortcut → Connect and paste the token into “Shortcut API token”, then save. Enable the needed commands on an Tooluse.net API key and give that key to your client. This integration reads story metadata and workflows; search returns one page with nextToken for an explicit next call. It does not write stories, and managed OAuth is not implemented. Revoke or rotate the token in Shortcut and replace it in the saved connection.</li>
</ol>
<p><a href="https://app.shortcut.com/settings/account/api-tokens">Official credential setup</a></p>
<h2>Where to enter credentials</h2>
<p>In the integration page, sign in, choose your workspace and open Connect. If a <strong>Credentials</strong> choice is shown, select <strong>Use my credentials</strong>. Fill the following connection fields and save. Provider credentials belong in this form, never in an MCP configuration or tool input.</p>
<div class="nb-table-scroll"><table>
<thead>
<tr>
<th>Connection field</th>
<th>Requirement</th>
</tr>
</thead>
<tbody><tr>
<td>Shortcut API token</td>
<td>Required</td>
</tr>
</tbody></table>
</div><p>Open API keys and create a Tooluse.net key for the enabled commands.</p>
<p>Set TOOLUSE_API_KEY in your client and use the shared MCP configuration.</p>
<p><a href="https://help.tooluse.net/clients">Configure Claude Code, Codex or Cursor once</a></p>

<h2>Permissions and results</h2>

<p>If you have more than one workspace, check the selected workspace in the connection or API-key dialog before saving. Roles, enabled commands, expiry and revocation use Tooluse.net&#39;s existing permissions. Disabling a connection or revoking a key immediately prevents new calls.</p>

<p>Send one Claude tool_use block per request. Keep the same Idempotency-Key when retrying the same request; use a new key for a new call. The response includes the shared Tooluse.net receipt and Claude tool_result. Check both HTTP status and the returned tool result before treating a call as successful.</p>

<p>Your connection&#39;s daily allowance and key permissions also apply. Adding a connection does not make a provider request.</p>

<p>Calls return the shared execution receipt and a Claude tool_result. Provider output varies by operation; consult the provider documentation for its response fields. Unconfirmed calls should be checked before retrying.</p>

<h2>Call from your client</h2>

<p>Use the shared MCP configuration. Refresh your client&#39;s tool list after saving the connection or changing key permissions, then call the returned tool name with the example input below.</p>

<p><a href="https://help.tooluse.net/clients">Configure Claude Code, Codex or Cursor once</a></p>

<h2>Discover your enabled tools</h2>

<p>List permitted tools in Claude format. Read every page using page and size (maximum 100) until all results have been received. Use the returned name, not a catalog capability identifier, in the tool_use block.</p>

<pre><code class="language-bash">curl 'https://api.tooluse.net/v1/tools' \
  -H "Authorization: Bearer $TOOLUSE_API_KEY"
</code></pre>

<p>Find this command in the tool list permitted by your key. Replace svc_FROM_YOUR_TOOL_LIST with its returned name. Use a new Idempotency-Key for each new call and retain it when retrying that same call.</p>

<h2>HTTP call</h2>

<pre><code class="language-bash">curl 'https://api.tooluse.net/v1/tool-calls' \
  -H "Authorization: Bearer $TOOLUSE_API_KEY" \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: replace-with-a-new-call-id' \
  --data '{
  "type": "tool_use",
  "id": "toolu_example",
  "name": "svc_FROM_YOUR_TOOL_LIST",
  "input": {
    "query": {
      "query": "is:unstarted",
      "page_size": 20
    }
  }
}'
</code></pre>

<p>Send one Claude tool_use block per request. Keep the same Idempotency-Key when retrying the same request; use a new key for a new call. The response includes the shared Tooluse.net receipt and Claude tool_result. Check both HTTP status and the returned tool result before treating a call as successful.</p>

<h2>Commands</h2>

<details id="command-shortcut-stories-search">
<summary><span>Search stories — <code>shortcut.<wbr>stories.<wbr>search</code></span></summary>
<p>Search one explicit page of Shortcut stories with slim provider results. Returns safe story metadata, total and nextToken. Pass nextToken as query.next with the same query and page_size; no automatic pagination. The provider exposes only the first 1,000 matches.</p>

<p>This is a read operation. Provider rate limits and data access rules still apply.</p>

<p><a href="https://www.tooluse.net/tools/integrations/shortcut?command=shortcut.stories.search">Connect and use</a></p>

<p><strong>Parameters</strong></p>

<p>Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.</p>

<div class="nb-table-scroll"><table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
<th>Required in parent</th>
<th>Description</th>
<th>Constraints</th>
</tr>
</thead>
<tbody><tr>
<td><code>query</code></td>
<td>object</td>
<td>Required</td>
<td></td>
<td><code>additionalProperties: false</code></td>
</tr>
<tr>
<td><code>query.query</code></td>
<td>string</td>
<td>Required</td>
<td>Shortcut search expression. See the official search operators guide.</td>
<td><code>minLength: 1; maxLength: 4096</code></td>
</tr>
<tr>
<td><code>query.page_size</code></td>
<td>integer</td>
<td>Required</td>
<td>Number of results in this page, from 1 to 250.</td>
<td><code>minimum: 1; maximum: 250</code></td>
</tr>
<tr>
<td><code>query.next</code></td>
<td>string</td>
<td>Optional</td>
<td>Opaque nextToken returned by the previous response. Keep query and page_size unchanged.</td>
<td><code>minLength: 1; maxLength: 4096</code></td>
</tr>
</tbody></table>
</div>
<p><strong>Full JSON Schema</strong></p>

<p><a href="https://api.tooluse.net/v1/integrations/shortcut/commands/shortcut.stories.search">Full JSON Schema</a></p>

<p><strong>Example input</strong></p>

<pre><code class="language-json">{
  "query": {
    "query": "is:unstarted",
    "page_size": 20
  }
}
</code></pre>

<p>At most 1 provider requests per invocation; timeout: 30 seconds.</p>

</details>
<details id="command-shortcut-stories-get">
<summary><span>Get story — <code>shortcut.<wbr>stories.<wbr>get</code></span></summary>
<p>Read safe metadata for one Shortcut story by numeric story ID. Descriptions, comments, tasks and private custom fields are omitted.</p>

<p>This is a read operation. Provider rate limits and data access rules still apply.</p>

<p><a href="https://www.tooluse.net/tools/integrations/shortcut?command=shortcut.stories.get">Connect and use</a></p>

<p><strong>Parameters</strong></p>

<p>Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.</p>

<div class="nb-table-scroll"><table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
<th>Required in parent</th>
<th>Description</th>
<th>Constraints</th>
</tr>
</thead>
<tbody><tr>
<td><code>path</code></td>
<td>object</td>
<td>Required</td>
<td></td>
<td><code>additionalProperties: false</code></td>
</tr>
<tr>
<td><code>path.story-public-id</code></td>
<td>integer</td>
<td>Required</td>
<td>Positive numeric Shortcut story ID.</td>
<td><code>minimum: 1; maximum: 9007199254740991</code></td>
</tr>
</tbody></table>
</div>
<p><strong>Full JSON Schema</strong></p>

<p><a href="https://api.tooluse.net/v1/integrations/shortcut/commands/shortcut.stories.get">Full JSON Schema</a></p>

<p><strong>Example input</strong></p>

<pre><code class="language-json">{
  "path": {
    "story-public-id": 123
  }
}
</code></pre>

<p>At most 1 provider requests per invocation; timeout: 30 seconds.</p>

</details>
<details id="command-shortcut-workflows-list">
<summary><span>List workflows — <code>shortcut.<wbr>workflows.<wbr>list</code></span></summary>
<p>List workspace workflow IDs, names and state IDs, names and types. This provider endpoint has no pagination; one bounded response is returned.</p>

<p>This is a read operation. Provider rate limits and data access rules still apply.</p>

<p><a href="https://www.tooluse.net/tools/integrations/shortcut?command=shortcut.workflows.list">Connect and use</a></p>

<p><strong>Parameters</strong></p>

<p>Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.</p>

<p>This tool has no input parameters.</p>

<p><strong>Full JSON Schema</strong></p>

<p><a href="https://api.tooluse.net/v1/integrations/shortcut/commands/shortcut.workflows.list">Full JSON Schema</a></p>

<p><strong>Example input</strong></p>

<pre><code class="language-json">{}
</code></pre>

<p>At most 1 provider requests per invocation; timeout: 30 seconds.</p>

</details>
<h2>Errors</h2>

<p>Check the key&#39;s expiry, revocation, workspace and allowed operations.</p>

<p>Reuse the same idempotency key only for the same request.</p>

<p>The connection or provider limit has been reached. Check the receipt before retrying.</p>

<h2>Test the connection</h2>

<p>Open the integration&#39;s commands below to inspect parameters and examples. Start with a read command for an account or resource you can access. Refresh your client&#39;s tool list, use the returned tool name, and check the execution result and usage. Provider charges and permissions still apply. Never test a write against production data without reviewing it.</p>

<p><a href="https://developer.shortcut.com/api/rest/v3/">Official provider documentation</a></p>

Source: https://help.tooluse.net/integrations/shortcut/index.mdx