Shortcut MCP server
140 operations0 webhooks
Manage Shortcut stories, epics, projects, workflows, labels, documents, and workspace resources through the REST API v3.
Try Shortcut with your agent
Connect Shortcut, then paste this into Claude, ChatGPT or Cursor. For ideas from other apps, see the use cases.
Using Corsair, show me what you can do in Shortcut on my account, then run one read-only example and show me the result.
Shortcut tools and triggers
Tools are what your agent can do in Shortcut through Corsair's MCP server. Triggers are the Shortcut events a routine can start from.
Create Category
- PostWrite
Create Category
createCategory.post
Create Doc
- PostWrite
Create Doc
createDoc.post
Create Entity Template
- PostWrite
Create Entity Template
createEntityTemplate.post
Create Epic
- PostWrite
Create Epic
createEpic.post
Create Epic Comment
- PostDestructive
Create Epic Comment
createEpicComment.post
Create Epic Comment Comment
- PostDestructive
Create Epic Comment Comment
createEpicCommentComment.post
Create Epic Health
- PostWrite
Create Epic Health
createEpicHealth.post
Create Group
- PostWrite
Create Group
createGroup.post
Create Iteration
- PostWrite
Create Iteration
createIteration.post
Create Label
- PostWrite
Create Label
createLabel.post
Create Linked File
- PostWrite
Create Linked File
createLinkedFile.post
Create Milestone
- PostWrite
Create Milestone
createMilestone.post
Create Multiple Stories
- PostWrite
Create Multiple Stories
createMultipleStories.post
Create Objective
- PostWrite
Create Objective
createObjective.post
Create Objective Health
- PostWrite
Create Objective Health
createObjectiveHealth.post
Create Project
- PostWrite
Create Project
createProject.post
Create Story
- PostWrite
Create Story
createStory.post
Create Story Comment
- PostDestructive
Create Story Comment
createStoryComment.post
Create Story From Template
- PostWrite
Create Story From Template
createStoryFromTemplate.post
Create Story Link
- PostWrite
Create Story Link
createStoryLink.post
Create Story Reaction
- PostWrite
Create Story Reaction
createStoryReaction.post
Create Task
- PostWrite
Create Task
createTask.post
Delete Category
- DeleteDestructive
Delete Category
deleteCategory.delete
Delete Custom Field
- DeleteDestructive
Delete Custom Field
deleteCustomField.delete
Delete Doc
- DeleteDestructive
Delete Doc
deleteDoc.delete
Delete Entity Template
- DeleteDestructive
Delete Entity Template
deleteEntityTemplate.delete
Delete Epic
- DeleteDestructive
Delete Epic
deleteEpic.delete
Delete Epic Comment
- DeleteDestructive
Delete Epic Comment
deleteEpicComment.delete
Delete File
- DeleteDestructive
Delete File
deleteFile.delete
Delete Iteration
- DeleteDestructive
Delete Iteration
deleteIteration.delete
Delete Label
- DeleteDestructive
Delete Label
deleteLabel.delete
Delete Linked File
- DeleteDestructive
Delete Linked File
deleteLinkedFile.delete
Delete Milestone
- DeleteDestructive
Delete Milestone
deleteMilestone.delete
Delete Multiple Stories
- DeleteDestructive
Delete Multiple Stories
deleteMultipleStories.delete
Delete Objective
- DeleteDestructive
Delete Objective
deleteObjective.delete
Delete Project
- DeleteDestructive
Delete Project
deleteProject.delete
Delete Story
- DeleteDestructive
Delete Story
deleteStory.delete
Delete Story Comment
- DeleteDestructive
Delete Story Comment
deleteStoryComment.delete
Delete Story Link
- DeleteDestructive
Delete Story Link
deleteStoryLink.delete
Delete Story Reaction
- DeleteDestructive
Delete Story Reaction
deleteStoryReaction.delete
Delete Task
- DeleteDestructive
Delete Task
deleteTask.delete
Disable Iterations
- PutWrite
Disable Iterations
disableIterations.put
Disable Story Templates
- PutWrite
Disable Story Templates
disableStoryTemplates.put
Enable Iterations
- PutWrite
Enable Iterations
enableIterations.put
Enable Story Templates
- PutWrite
Enable Story Templates
enableStoryTemplates.put
Get Category
- GetRead-only
Get Category
getCategory.get
Get Current Member Info
- GetRead-only
Get Current Member Info
getCurrentMemberInfo.get
Get Custom Field
- GetRead-only
Get Custom Field
getCustomField.get
Get Doc
- GetRead-only
Get Doc
getDoc.get
Get Entity Template
- GetRead-only
Get Entity Template
getEntityTemplate.get
Get Epic
- GetRead-only
Get Epic
getEpic.get
Get Epic Comment
- GetRead-only
Get Epic Comment
getEpicComment.get
Get Epic Health
- GetRead-only
Get Epic Health
getEpicHealth.get
Get Epic Workflow
- GetRead-only
Get Epic Workflow
getEpicWorkflow.get
Get External Link Stories
- GetRead-only
Get External Link Stories
getExternalLinkStories.get
Get File
- GetRead-only
Get File
getFile.get
Get Group
- GetRead-only
Get Group
getGroup.get
Get Iteration
- GetRead-only
Get Iteration
getIteration.get
Get Key Result
- GetRead-only
Get Key Result
getKeyResult.get
Get Label
- GetRead-only
Get Label
getLabel.get
Get Linked File
- GetRead-only
Get Linked File
getLinkedFile.get
Get Member
- GetRead-only
Get Member
getMember.get
Get Milestone
- GetRead-only
Get Milestone
getMilestone.get
Get Objective
- GetRead-only
Get Objective
getObjective.get
Get Objective Health
- GetRead-only
Get Objective Health
getObjectiveHealth.get
Get Project
- GetRead-only
Get Project
getProject.get
Get Repository
- GetRead-only
Get Repository
getRepository.get
Get Story
- GetRead-only
Get Story
getStory.get
Get Story Comment
- GetRead-only
Get Story Comment
getStoryComment.get
Get Story Link
- GetRead-only
Get Story Link
getStoryLink.get
Get Task
- GetRead-only
Get Task
getTask.get
Get Workflow
- GetRead-only
Get Workflow
getWorkflow.get
Link Document To Epic
- PutWrite
Link Document to Epic
linkDocumentToEpic.put
List Categories
- GetRead-only
List Categories
listCategories.get
List Category Milestones
- GetRead-only
List Category Milestones
listCategoryMilestones.get
List Category Objectives
- GetRead-only
List Category Objectives
listCategoryObjectives.get
List Custom Fields
- GetRead-only
List Custom Fields
listCustomFields.get
List Docs
- GetRead-only
List Docs
listDocs.get
List Document Epics
- GetRead-only
List Document Epics
listDocumentEpics.get
List Entity Templates
- GetRead-only
List Entity Templates
listEntityTemplates.get
List Epic Comments
- GetRead-only
List Epic Comments
listEpicComments.get
List Epic Documents
- GetRead-only
List Epic Documents
listEpicDocuments.get
List Epic Healths
- GetRead-only
List Epic Healths
listEpicHealths.get
List Epic Stories
- GetRead-only
List Epic Stories
listEpicStories.get
List Epics
- GetRead-only
List Epics
listEpics.get
List Epics Paginated
- GetRead-only
List Epics Paginated
listEpicsPaginated.get
List Files
- GetRead-only
List Files
listFiles.get
List Group Stories
- GetRead-only
List Group Stories
listGroupStories.get
List Groups
- GetRead-only
List Groups
listGroups.get
List Iteration Stories
- GetRead-only
List Iteration Stories
listIterationStories.get
List Iterations
- GetRead-only
List Iterations
listIterations.get
List Label Epics
- GetRead-only
List Label Epics
listLabelEpics.get
List Label Stories
- GetRead-only
List Label Stories
listLabelStories.get
List Labels
- GetRead-only
List Labels
listLabels.get
List Linked Files
- GetRead-only
List Linked Files
listLinkedFiles.get
List Members
- GetRead-only
List Members
listMembers.get
List Milestone Epics
- GetRead-only
List Milestone Epics
listMilestoneEpics.get
List Milestones
- GetRead-only
List Milestones
listMilestones.get
List Objective Epics
- GetRead-only
List Objective Epics
listObjectiveEpics.get
List Objective Healths
- GetRead-only
List Objective Healths
listObjectiveHealths.get
List Objectives
- GetRead-only
List Objectives
listObjectives.get
List Projects
- GetRead-only
List Projects
listProjects.get
List Repositories
- GetRead-only
List Repositories
listRepositories.get
List Stories
- GetRead-only
List Stories
listStories.get
List Story Comment
- GetRead-only
List Story Comment
listStoryComment.get
List Story Sub Tasks
- GetRead-only
List Story Sub tasks
listStorySubTasks.get
List Workflows
- GetRead-only
List Workflows
listWorkflows.get
Query Stories
- PostRead-only
Query Stories
queryStories.post
Search
- GetRead-only
Search
search.get
Search Documents
- GetRead-only
Search Documents
searchDocuments.get
Search Epics
- GetRead-only
Search Epics
searchEpics.get
Search Iterations
- GetRead-only
Search Iterations
searchIterations.get
Search Milestones
- GetRead-only
Search Milestones
searchMilestones.get
Search Objectives
- GetRead-only
Search Objectives
searchObjectives.get
Search Stories
- GetRead-only
Search Stories
searchStories.get
Story History
- GetRead-only
Story History
storyHistory.get
Unlink Comment Thread From Slack
- PostWrite
Unlink Comment thread from Slack
unlinkCommentThreadFromSlack.post
Unlink Document From Epic
- DeleteDestructive
Unlink Document from Epic
unlinkDocumentFromEpic.delete
Update Category
- PutWrite
Update Category
updateCategory.put
Update Custom Field
- PutWrite
Update Custom Field
updateCustomField.put
Update Doc
- PutWrite
Update Doc
updateDoc.put
Update Entity Template
- PutWrite
Update Entity Template
updateEntityTemplate.put
Update Epic
- PutWrite
Update Epic
updateEpic.put
Update Epic Comment
- PutWrite
Update Epic Comment
updateEpicComment.put
Update File
- PutWrite
Update File
updateFile.put
Update Group
- PutWrite
Update Group
updateGroup.put
Update Health
- PutWrite
Update Health
updateHealth.put
Update Iteration
- PutWrite
Update Iteration
updateIteration.put
Update Key Result
- PutWrite
Update Key Result
updateKeyResult.put
Update Label
- PutWrite
Update Label
updateLabel.put
Update Linked File
- PutWrite
Update Linked File
updateLinkedFile.put
Update Milestone
- PutWrite
Update Milestone
updateMilestone.put
Update Multiple Stories
- PutWrite
Update Multiple Stories
updateMultipleStories.put
Update Objective
- PutWrite
Update Objective
updateObjective.put
Update Project
- PutWrite
Update Project
updateProject.put
Update Story
- PutWrite
Update Story
updateStory.put
Update Story Comment
- PutWrite
Update Story Comment
updateStoryComment.put
Update Story Link
- PutWrite
Update Story Link
updateStoryLink.put
Update Task
- PutWrite
Update Task
updateTask.put
Upload Files
- PostWrite
Upload Files
uploadFiles.post
Connect Shortcut to Claude, ChatGPT or Cursor
- 1
Connect Shortcut in Corsair
Add your Shortcut API key once in Corsair. Corsair stores the credential encrypted and makes the Shortcut API calls for your agent, so it never goes into a prompt or a config file. Connect Shortcut
If your link lets the agent add apps, you can skip this: it gives you a sign-in link the first time it needs Shortcut. On a ChatGPT personal plan, connect Shortcut here first.
- 2
Add Corsair's MCP server to your agent
Every client uses the same address:
https://mcp.corsair.dev/mcpOpen Customize → Connectors → Add custom connector, paste the address, then select Connect.Add a custom MCP server with the address and choose OAuth. Personal plans get read tools only.Add to CursorOr add this to~/.cursor/mcp.json. Cursor opens Corsair to sign in the first time it connects.{ "mcpServers": { "corsair": { "url": "https://mcp.corsair.dev/mcp" } } }Run this, then run/mcpin Claude Code to sign in.claude mcp add --transport http corsair https://mcp.corsair.dev/mcpCodex, Gemini CLI, VS Code, Zed and other clients with OAuth sign-in work the same way. Clients without it, such as GitHub Copilot's coding agent, use a link's own address and an API key. Setup for every client
- 3
Sign in and choose what needs your approval
Your client opens Corsair to sign in. Pick a link: the apps your agent can use and a mode that decides what it may do without asking. In the default Cautious mode, Shortcut's read and write operations run right away and its 23 destructive operations wait for your approval. Strict mode asks before every write and refuses destructive operations, and Read mode allows reads only.
FAQ
Install corsair and @corsair-dev/shortcut, add the Shortcut plugin, and connect with an API key. Then call methods like corsair.shortcut.api.createCategory.post() from your app. Corsair keeps each tenant isolated.
Yes. Shortcut requires an API key from your Shortcut account or developer dashboard. Create credentials with access that matches what you automate, then paste them into Corsair or connect through managed auth in Hub.
Yes. One Corsair client can hit Shortcut, GitHub, Notion, Stripe, and the rest. Trigger Shortcut from a webhook, push updates to Slack, or chain actions across plugins. Same tenant context across integrations, plain TypeScript.
Teams use Corsair for manage Shortcut stories, epics, projects, workflows, labels, documents, and workspace resources through the REST API v3. Common builds include sync jobs, admin tooling, and agents that call Shortcut APIs from your backend.
The SDK is open source. Self-host and you pay Corsair nothing for the integration layer. Hub bills for hosted auth and execution, not per Shortcut API call. Hub has a generous free tier. For hobby projects you can probably run the whole thing on free. Paid plans start to matter with more tenants or heavier traffic.
We maintain @corsair-dev/shortcut in the open repo. When Shortcut ships API changes, upgrade the package. Your call sites stay typed. You should not need to rewrite the integration layer each time.
No. Corsair does not read your Shortcut data or hold individual access credentials. Credentials stay in your database. API calls run on your instance. We do not store Shortcut data on your behalf.
Yes. Add https://mcp.corsair.dev/mcp as a custom connector or MCP server in Claude, ChatGPT, Cursor, VS Code, Claude Code, Codex or any client that supports remote MCP servers with OAuth sign-in, then sign in to Corsair. On ChatGPT personal plans, custom servers currently get read tools only.
Yes. Put Shortcut on a link in Strict mode and every write waits for your approval, while destructive actions are refused. The default Cautious mode asks only before the 23 destructive Shortcut operations. You can change a link's mode at hub.corsair.dev/me.