get-epic
Retrieve Shortcut epic details using its public ID to access project management information and track progress.
Instructions
Get a Shortcut epic by public ID
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| epicPublicId | Yes | The public ID of the epic to get |
Implementation Reference
- src/tools/epics.ts:93-102 (handler)The handler function that executes the 'get-epic' tool logic: fetches the epic using the Shortcut client, checks for existence, and formats the result using base utilities.
async getEpic(epicPublicId: number) { const epic = await this.client.getEpic(epicPublicId); if (!epic) throw new Error(`Failed to retrieve Shortcut epic with public ID: ${epicPublicId}`); return this.toResult( `Epic: ${epicPublicId}`, await this.entityWithRelatedEntities(epic, "epic"), ); } - src/tools/epics.ts:13-18 (registration)Registers the 'get-epic' MCP tool with the server, including name, description, input schema, and thin wrapper handler delegating to getEpic method.
server.tool( "get-epic", "Get a Shortcut epic by public ID", { epicPublicId: z.number().positive().describe("The public ID of the epic to get") }, async ({ epicPublicId }) => await tools.getEpic(epicPublicId), ); - src/tools/epics.ts:16-16 (schema)Zod schema for the input parameter 'epicPublicId' used in the tool registration.
{ epicPublicId: z.number().positive().describe("The public ID of the epic to get") },