productivity
Shortcut MCP, CLI, and Lua Integration for AI Agents
Shortcut integration docs for AI agents: MCP gateway setup, Shortcut CLI commands, Lua API reference, credentials, and function schemas.Shortcut for agents
Credentials can be configured manually in web or CLI hosts.
Use this integration from Lua code mode, the headless integrations CLI, or the KosmoKrator MCP gateway. The same package metadata powers all three surfaces.
Agent Surfaces
Machine-Readable Metadata
Function Catalog
| Function | Type | Parameters | Description |
|---|---|---|---|
shortcut.shortcut_list_categories | Read read | 0 | List Categories Official Shortcut endpoint: GET /api/v3/categories. |
shortcut.shortcut_create_category | Write write | 1 | Create Category Official Shortcut endpoint: POST /api/v3/categories. |
shortcut.shortcut_get_category | Read read | 1 | Get Category Official Shortcut endpoint: GET /api/v3/categories/{category-public-id}. |
shortcut.shortcut_update_category | Write write | 2 | Update Category Official Shortcut endpoint: PUT /api/v3/categories/{category-public-id}. |
shortcut.shortcut_delete_category | Write write | 1 | Delete Category Official Shortcut endpoint: DELETE /api/v3/categories/{category-public-id}. |
shortcut.shortcut_list_category_milestones | Read read | 1 | List Category Milestones Official Shortcut endpoint: GET /api/v3/categories/{category-public-id}/milestones. |
shortcut.shortcut_list_category_objectives | Read read | 1 | List Category Objectives Official Shortcut endpoint: GET /api/v3/categories/{category-public-id}/objectives. |
shortcut.shortcut_list_custom_fields | Read read | 0 | List Custom Fields Official Shortcut endpoint: GET /api/v3/custom-fields. |
shortcut.shortcut_get_custom_field | Read read | 1 | Get Custom Field Official Shortcut endpoint: GET /api/v3/custom-fields/{custom-field-public-id}. |
shortcut.shortcut_update_custom_field | Write write | 2 | Update Custom Field Official Shortcut endpoint: PUT /api/v3/custom-fields/{custom-field-public-id}. |
shortcut.shortcut_delete_custom_field | Write write | 1 | Delete Custom Field Official Shortcut endpoint: DELETE /api/v3/custom-fields/{custom-field-public-id}. |
shortcut.shortcut_list_docs | Read read | 0 | List Docs Official Shortcut endpoint: GET /api/v3/documents. |
shortcut.shortcut_create_doc | Write write | 1 | Create Doc Official Shortcut endpoint: POST /api/v3/documents. |
shortcut.shortcut_get_doc | Read read | 2 | Get Doc Official Shortcut endpoint: GET /api/v3/documents/{doc-public-id}. |
shortcut.shortcut_update_doc | Write write | 2 | Update Doc Official Shortcut endpoint: PUT /api/v3/documents/{doc-public-id}. |
shortcut.shortcut_delete_doc | Write write | 2 | Delete Doc Official Shortcut endpoint: DELETE /api/v3/documents/{doc-public-id}. |
shortcut.shortcut_list_document_epics | Read read | 1 | List Document Epics Official Shortcut endpoint: GET /api/v3/documents/{doc-public-id}/epics. |
shortcut.shortcut_link_document_to_epic | Read read | 2 | Link Document to Epic Official Shortcut endpoint: PUT /api/v3/documents/{doc-public-id}/epics/{epic-public-id}. |
shortcut.shortcut_unlink_document_from_epic | Read read | 2 | Unlink Document from Epic Official Shortcut endpoint: DELETE /api/v3/documents/{doc-public-id}/epics/{epic-public-id}. |
shortcut.shortcut_load_tiptap_document_json | Read read | 2 | Load Tiptap Document JSON Official Shortcut endpoint: GET /api/v3/documents/{doc-public-id}/tiptap-load. |
shortcut.shortcut_list_entity_templates | Read read | 0 | List Entity Templates Official Shortcut endpoint: GET /api/v3/entity-templates. |
shortcut.shortcut_create_entity_template | Write write | 1 | Create Entity Template Official Shortcut endpoint: POST /api/v3/entity-templates. |
shortcut.shortcut_disable_story_templates | Write write | 0 | Disable Story Templates Official Shortcut endpoint: PUT /api/v3/entity-templates/disable. |
shortcut.shortcut_enable_story_templates | Write write | 0 | Enable Story Templates Official Shortcut endpoint: PUT /api/v3/entity-templates/enable. |
shortcut.shortcut_get_entity_template | Read read | 1 | Get Entity Template Official Shortcut endpoint: GET /api/v3/entity-templates/{entity-template-public-id}. |
shortcut.shortcut_update_entity_template | Write write | 2 | Update Entity Template Official Shortcut endpoint: PUT /api/v3/entity-templates/{entity-template-public-id}. |
shortcut.shortcut_delete_entity_template | Write write | 1 | Delete Entity Template Official Shortcut endpoint: DELETE /api/v3/entity-templates/{entity-template-public-id}. |
shortcut.shortcut_get_epic_workflow | Read read | 0 | Get Epic Workflow Official Shortcut endpoint: GET /api/v3/epic-workflow. |
shortcut.shortcut_list_epics | Read read | 1 | List Epics Official Shortcut endpoint: GET /api/v3/epics. |
shortcut.shortcut_create_epic | Write write | 1 | Create Epic Official Shortcut endpoint: POST /api/v3/epics. |
shortcut.shortcut_list_epics_paginated | Read read | 3 | List Epics Paginated Official Shortcut endpoint: GET /api/v3/epics/paginated. |
shortcut.shortcut_get_epic | Read read | 1 | Get Epic Official Shortcut endpoint: GET /api/v3/epics/{epic-public-id}. |
shortcut.shortcut_update_epic | Write write | 2 | Update Epic Official Shortcut endpoint: PUT /api/v3/epics/{epic-public-id}. |
shortcut.shortcut_delete_epic | Write write | 1 | Delete Epic Official Shortcut endpoint: DELETE /api/v3/epics/{epic-public-id}. |
shortcut.shortcut_list_epic_comments | Read read | 1 | List Epic Comments Official Shortcut endpoint: GET /api/v3/epics/{epic-public-id}/comments. |
shortcut.shortcut_create_epic_comment | Write write | 2 | Create Epic Comment Official Shortcut endpoint: POST /api/v3/epics/{epic-public-id}/comments. |
shortcut.shortcut_create_epic_comment_comment | Write write | 3 | Create Epic Comment Comment Official Shortcut endpoint: POST /api/v3/epics/{epic-public-id}/comments/{comment-public-id}. |
shortcut.shortcut_get_epic_comment | Read read | 2 | Get Epic Comment Official Shortcut endpoint: GET /api/v3/epics/{epic-public-id}/comments/{comment-public-id}. |
shortcut.shortcut_update_epic_comment | Write write | 3 | Update Epic Comment Official Shortcut endpoint: PUT /api/v3/epics/{epic-public-id}/comments/{comment-public-id}. |
shortcut.shortcut_delete_epic_comment | Write write | 2 | Delete Epic Comment Official Shortcut endpoint: DELETE /api/v3/epics/{epic-public-id}/comments/{comment-public-id}. |
shortcut.shortcut_list_epic_documents | Read read | 1 | List Epic Documents Official Shortcut endpoint: GET /api/v3/epics/{epic-public-id}/documents. |
shortcut.shortcut_get_epic_health | Read read | 1 | Get Epic Health Official Shortcut endpoint: GET /api/v3/epics/{epic-public-id}/health. |
shortcut.shortcut_create_epic_health | Write write | 2 | Create Epic Health Official Shortcut endpoint: POST /api/v3/epics/{epic-public-id}/health. |
shortcut.shortcut_list_epic_healths | Read read | 1 | List Epic Healths Official Shortcut endpoint: GET /api/v3/epics/{epic-public-id}/health-history. |
shortcut.shortcut_list_epic_stories | Read read | 2 | List Epic Stories Official Shortcut endpoint: GET /api/v3/epics/{epic-public-id}/stories. |
shortcut.shortcut_get_external_link_stories | Read read | 1 | Get External Link Stories Official Shortcut endpoint: GET /api/v3/external-link/stories. |
shortcut.shortcut_list_files | Read read | 0 | List Files Official Shortcut endpoint: GET /api/v3/files. |
shortcut.shortcut_upload_files | Read read | 5 | Upload Files Official Shortcut endpoint: POST /api/v3/files. |
shortcut.shortcut_get_file | Read read | 1 | Get File Official Shortcut endpoint: GET /api/v3/files/{file-public-id}. |
shortcut.shortcut_update_file | Write write | 2 | Update File Official Shortcut endpoint: PUT /api/v3/files/{file-public-id}. |
shortcut.shortcut_delete_file | Write write | 1 | Delete File Official Shortcut endpoint: DELETE /api/v3/files/{file-public-id}. |
shortcut.shortcut_list_groups | Read read | 1 | List Groups Official Shortcut endpoint: GET /api/v3/groups. |
shortcut.shortcut_create_group | Write write | 1 | Create Group Official Shortcut endpoint: POST /api/v3/groups. |
shortcut.shortcut_get_group | Read read | 1 | Get Group Official Shortcut endpoint: GET /api/v3/groups/{group-public-id}. |
shortcut.shortcut_update_group | Write write | 2 | Update Group Official Shortcut endpoint: PUT /api/v3/groups/{group-public-id}. |
shortcut.shortcut_list_group_stories | Read read | 3 | List Group Stories Official Shortcut endpoint: GET /api/v3/groups/{group-public-id}/stories. |
shortcut.shortcut_update_health | Write write | 2 | Update Health Official Shortcut endpoint: PUT /api/v3/health/{health-public-id}. |
shortcut.shortcut_create_generic_integration | Write write | 1 | Create Generic Integration Official Shortcut endpoint: POST /api/v3/integrations/webhook. |
shortcut.shortcut_get_generic_integration | Read read | 1 | Get Generic Integration Official Shortcut endpoint: GET /api/v3/integrations/webhook/{integration-public-id}. |
shortcut.shortcut_delete_generic_integration | Write write | 1 | Delete Generic Integration Official Shortcut endpoint: DELETE /api/v3/integrations/webhook/{integration-public-id}. |
shortcut.shortcut_list_iterations | Read read | 0 | List Iterations Official Shortcut endpoint: GET /api/v3/iterations. |
shortcut.shortcut_create_iteration | Write write | 1 | Create Iteration Official Shortcut endpoint: POST /api/v3/iterations. |
shortcut.shortcut_disable_iterations | Write write | 0 | Disable Iterations Official Shortcut endpoint: PUT /api/v3/iterations/disable. |
shortcut.shortcut_enable_iterations | Write write | 0 | Enable Iterations Official Shortcut endpoint: PUT /api/v3/iterations/enable. |
shortcut.shortcut_get_iteration | Read read | 1 | Get Iteration Official Shortcut endpoint: GET /api/v3/iterations/{iteration-public-id}. |
shortcut.shortcut_update_iteration | Write write | 2 | Update Iteration Official Shortcut endpoint: PUT /api/v3/iterations/{iteration-public-id}. |
shortcut.shortcut_delete_iteration | Write write | 1 | Delete Iteration Official Shortcut endpoint: DELETE /api/v3/iterations/{iteration-public-id}. |
shortcut.shortcut_list_iteration_stories | Read read | 2 | List Iteration Stories Official Shortcut endpoint: GET /api/v3/iterations/{iteration-public-id}/stories. |
shortcut.shortcut_get_key_result | Read read | 1 | Get Key Result Official Shortcut endpoint: GET /api/v3/key-results/{key-result-public-id}. |
shortcut.shortcut_update_key_result | Write write | 2 | Update Key Result Official Shortcut endpoint: PUT /api/v3/key-results/{key-result-public-id}. |
shortcut.shortcut_list_labels | Read read | 1 | List Labels Official Shortcut endpoint: GET /api/v3/labels. |
shortcut.shortcut_create_label | Write write | 1 | Create Label Official Shortcut endpoint: POST /api/v3/labels. |
shortcut.shortcut_get_label | Read read | 1 | Get Label Official Shortcut endpoint: GET /api/v3/labels/{label-public-id}. |
shortcut.shortcut_update_label | Write write | 2 | Update Label Official Shortcut endpoint: PUT /api/v3/labels/{label-public-id}. |
shortcut.shortcut_delete_label | Write write | 1 | Delete Label Official Shortcut endpoint: DELETE /api/v3/labels/{label-public-id}. |
shortcut.shortcut_list_label_epics | Read read | 1 | List Label Epics Official Shortcut endpoint: GET /api/v3/labels/{label-public-id}/epics. |
shortcut.shortcut_list_label_stories | Read read | 2 | List Label Stories Official Shortcut endpoint: GET /api/v3/labels/{label-public-id}/stories. |
shortcut.shortcut_list_linked_files | Read read | 0 | List Linked Files Official Shortcut endpoint: GET /api/v3/linked-files. |
shortcut.shortcut_create_linked_file | Write write | 1 | Create Linked File Official Shortcut endpoint: POST /api/v3/linked-files. |
shortcut.shortcut_get_linked_file | Read read | 1 | Get Linked File Official Shortcut endpoint: GET /api/v3/linked-files/{linked-file-public-id}. |
shortcut.shortcut_update_linked_file | Write write | 2 | Update Linked File Official Shortcut endpoint: PUT /api/v3/linked-files/{linked-file-public-id}. |
shortcut.shortcut_delete_linked_file | Write write | 1 | Delete Linked File Official Shortcut endpoint: DELETE /api/v3/linked-files/{linked-file-public-id}. |
shortcut.shortcut_get_current_member_info | Read read | 0 | Get Current Member Info Official Shortcut endpoint: GET /api/v3/member. |
shortcut.shortcut_list_members | Read read | 2 | List Members Official Shortcut endpoint: GET /api/v3/members. |
shortcut.shortcut_get_member | Read read | 2 | Get Member Official Shortcut endpoint: GET /api/v3/members/{member-public-id}. |
shortcut.shortcut_list_milestones | Read read | 0 | List Milestones Official Shortcut endpoint: GET /api/v3/milestones. |
shortcut.shortcut_create_milestone | Write write | 1 | Create Milestone Official Shortcut endpoint: POST /api/v3/milestones. |
shortcut.shortcut_get_milestone | Read read | 1 | Get Milestone Official Shortcut endpoint: GET /api/v3/milestones/{milestone-public-id}. |
shortcut.shortcut_update_milestone | Write write | 2 | Update Milestone Official Shortcut endpoint: PUT /api/v3/milestones/{milestone-public-id}. |
shortcut.shortcut_delete_milestone | Write write | 1 | Delete Milestone Official Shortcut endpoint: DELETE /api/v3/milestones/{milestone-public-id}. |
shortcut.shortcut_list_milestone_epics | Read read | 1 | List Milestone Epics Official Shortcut endpoint: GET /api/v3/milestones/{milestone-public-id}/epics. |
shortcut.shortcut_list_objectives | Read read | 0 | List Objectives Official Shortcut endpoint: GET /api/v3/objectives. |
shortcut.shortcut_create_objective | Write write | 1 | Create Objective Official Shortcut endpoint: POST /api/v3/objectives. |
shortcut.shortcut_get_objective | Read read | 1 | Get Objective Official Shortcut endpoint: GET /api/v3/objectives/{objective-public-id}. |
shortcut.shortcut_update_objective | Write write | 2 | Update Objective Official Shortcut endpoint: PUT /api/v3/objectives/{objective-public-id}. |
shortcut.shortcut_delete_objective | Write write | 1 | Delete Objective Official Shortcut endpoint: DELETE /api/v3/objectives/{objective-public-id}. |
shortcut.shortcut_list_objective_epics | Read read | 1 | List Objective Epics Official Shortcut endpoint: GET /api/v3/objectives/{objective-public-id}/epics. |
shortcut.shortcut_get_objective_health | Read read | 1 | Get Objective Health Official Shortcut endpoint: GET /api/v3/objectives/{objective-public-id}/health. |
shortcut.shortcut_create_objective_health | Write write | 2 | Create Objective Health Official Shortcut endpoint: POST /api/v3/objectives/{objective-public-id}/health. |
shortcut.shortcut_list_objective_healths | Read read | 1 | List Objective Healths Official Shortcut endpoint: GET /api/v3/objectives/{objective-public-id}/health-history. |
shortcut.shortcut_list_projects | Read read | 0 | List Projects Official Shortcut endpoint: GET /api/v3/projects. |
shortcut.shortcut_create_project | Write write | 1 | Create Project Official Shortcut endpoint: POST /api/v3/projects. |
shortcut.shortcut_get_project | Read read | 1 | Get Project Official Shortcut endpoint: GET /api/v3/projects/{project-public-id}. |
shortcut.shortcut_update_project | Write write | 2 | Update Project Official Shortcut endpoint: PUT /api/v3/projects/{project-public-id}. |
shortcut.shortcut_delete_project | Write write | 1 | Delete Project Official Shortcut endpoint: DELETE /api/v3/projects/{project-public-id}. |
shortcut.shortcut_list_stories | Read read | 2 | List Stories Official Shortcut endpoint: GET /api/v3/projects/{project-public-id}/stories. |
shortcut.shortcut_list_repositories | Read read | 0 | List Repositories Official Shortcut endpoint: GET /api/v3/repositories. |
shortcut.shortcut_get_repository | Read read | 1 | Get Repository Official Shortcut endpoint: GET /api/v3/repositories/{repo-public-id}. |
shortcut.shortcut_search | Read read | 5 | Search Official Shortcut endpoint: GET /api/v3/search. |
shortcut.shortcut_search_documents | Read read | 6 | Search Documents Official Shortcut endpoint: GET /api/v3/search/documents. |
shortcut.shortcut_search_epics | Read read | 5 | Search Epics Official Shortcut endpoint: GET /api/v3/search/epics. |
shortcut.shortcut_search_iterations | Read read | 5 | Search Iterations Official Shortcut endpoint: GET /api/v3/search/iterations. |
shortcut.shortcut_search_milestones | Read read | 5 | Search Milestones Official Shortcut endpoint: GET /api/v3/search/milestones. |
shortcut.shortcut_search_objectives | Read read | 5 | Search Objectives Official Shortcut endpoint: GET /api/v3/search/objectives. |
shortcut.shortcut_search_stories | Read read | 5 | Search Stories Official Shortcut endpoint: GET /api/v3/search/stories. |
shortcut.shortcut_create_story | Write write | 1 | Create Story Official Shortcut endpoint: POST /api/v3/stories. |
shortcut.shortcut_create_multiple_stories | Write write | 1 | Create Multiple Stories Official Shortcut endpoint: POST /api/v3/stories/bulk. |
shortcut.shortcut_update_multiple_stories | Write write | 1 | Update Multiple Stories Official Shortcut endpoint: PUT /api/v3/stories/bulk. |
shortcut.shortcut_delete_multiple_stories | Write write | 1 | Delete Multiple Stories Official Shortcut endpoint: DELETE /api/v3/stories/bulk. |
shortcut.shortcut_create_story_from_template | Write write | 1 | Create Story From Template Official Shortcut endpoint: POST /api/v3/stories/from-template. |
shortcut.shortcut_query_stories | Read read | 1 | Query Stories Official Shortcut endpoint: POST /api/v3/stories/search. |
shortcut.shortcut_get_story | Read read | 1 | Get Story Official Shortcut endpoint: GET /api/v3/stories/{story-public-id}. |
shortcut.shortcut_update_story | Write write | 2 | Update Story Official Shortcut endpoint: PUT /api/v3/stories/{story-public-id}. |
shortcut.shortcut_delete_story | Write write | 1 | Delete Story Official Shortcut endpoint: DELETE /api/v3/stories/{story-public-id}. |
shortcut.shortcut_list_story_comment | Read read | 1 | List Story Comment Official Shortcut endpoint: GET /api/v3/stories/{story-public-id}/comments. |
shortcut.shortcut_create_story_comment | Write write | 2 | Create Story Comment Official Shortcut endpoint: POST /api/v3/stories/{story-public-id}/comments. |
shortcut.shortcut_get_story_comment | Read read | 2 | Get Story Comment Official Shortcut endpoint: GET /api/v3/stories/{story-public-id}/comments/{comment-public-id}. |
shortcut.shortcut_update_story_comment | Write write | 3 | Update Story Comment Official Shortcut endpoint: PUT /api/v3/stories/{story-public-id}/comments/{comment-public-id}. |
shortcut.shortcut_delete_story_comment | Write write | 2 | Delete Story Comment Official Shortcut endpoint: DELETE /api/v3/stories/{story-public-id}/comments/{comment-public-id}. |
shortcut.shortcut_create_story_reaction | Write write | 3 | Create Story Reaction Official Shortcut endpoint: POST /api/v3/stories/{story-public-id}/comments/{comment-public-id}/reactions. |
shortcut.shortcut_delete_story_reaction | Write write | 3 | Delete Story Reaction Official Shortcut endpoint: DELETE /api/v3/stories/{story-public-id}/comments/{comment-public-id}/reactions. |
shortcut.shortcut_unlink_comment_thread_from_slack | Read read | 2 | Unlink Comment thread from Slack Official Shortcut endpoint: POST /api/v3/stories/{story-public-id}/comments/{comment-public-id}/unlink-from-slack. |
shortcut.shortcut_story_history | Read read | 1 | Story History Official Shortcut endpoint: GET /api/v3/stories/{story-public-id}/history. |
shortcut.shortcut_list_story_sub_tasks | Read read | 1 | List Story Sub tasks Official Shortcut endpoint: GET /api/v3/stories/{story-public-id}/sub-tasks. |
shortcut.shortcut_create_task | Write write | 2 | Create Task Official Shortcut endpoint: POST /api/v3/stories/{story-public-id}/tasks. |
shortcut.shortcut_get_task | Read read | 2 | Get Task Official Shortcut endpoint: GET /api/v3/stories/{story-public-id}/tasks/{task-public-id}. |
shortcut.shortcut_update_task | Write write | 3 | Update Task Official Shortcut endpoint: PUT /api/v3/stories/{story-public-id}/tasks/{task-public-id}. |
shortcut.shortcut_delete_task | Write write | 2 | Delete Task Official Shortcut endpoint: DELETE /api/v3/stories/{story-public-id}/tasks/{task-public-id}. |
shortcut.shortcut_create_story_link | Write write | 1 | Create Story Link Official Shortcut endpoint: POST /api/v3/story-links. |
shortcut.shortcut_get_story_link | Read read | 1 | Get Story Link Official Shortcut endpoint: GET /api/v3/story-links/{story-link-public-id}. |
shortcut.shortcut_update_story_link | Write write | 2 | Update Story Link Official Shortcut endpoint: PUT /api/v3/story-links/{story-link-public-id}. |
shortcut.shortcut_delete_story_link | Write write | 1 | Delete Story Link Official Shortcut endpoint: DELETE /api/v3/story-links/{story-link-public-id}. |
shortcut.shortcut_list_workflows | Read read | 0 | List Workflows Official Shortcut endpoint: GET /api/v3/workflows. |
shortcut.shortcut_get_workflow | Read read | 1 | Get Workflow Official Shortcut endpoint: GET /api/v3/workflows/{workflow-public-id}. |