get-iteration
Retrieve a specific iteration from Shortcut project management using its public ID to access detailed sprint information and progress data.
Instructions
Get a Shortcut iteration by public ID
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| iterationPublicId | Yes | The public ID of the iteration to get |
Implementation Reference
- src/tools/iterations.ts:133-145 (handler)Handler function that retrieves the iteration by public ID from the Shortcut client, handles errors, and formats the result using inherited methods from BaseTools.
async getIteration(iterationPublicId: number) { const iteration = await this.client.getIteration(iterationPublicId); if (!iteration) throw new Error( `Failed to retrieve Shortcut iteration with public ID: ${iterationPublicId}.`, ); return this.toResult( `Iteration: ${iterationPublicId}`, await this.entityWithRelatedEntities(iteration, "iteration"), ); } - src/tools/iterations.ts:30-37 (registration)Registration of the 'get-iteration' MCP tool, defining the name, description, input schema (iterationPublicId), and linking to the handler method.
server.tool( "get-iteration", "Get a Shortcut iteration by public ID", { iterationPublicId: z.number().positive().describe("The public ID of the iteration to get"), }, async ({ iterationPublicId }) => await tools.getIteration(iterationPublicId), ); - src/tools/iterations.ts:33-35 (schema)Input schema for the 'get-iteration' tool using Zod validation for iterationPublicId.
{ iterationPublicId: z.number().positive().describe("The public ID of the iteration to get"), },