create-story-comment
Add comments to Shortcut stories to provide updates, share feedback, or document progress within project workflows.
Instructions
Create a comment on a story
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| storyPublicId | Yes | The public ID of the story | |
| text | Yes | The text of the comment |
Implementation Reference
- src/tools/stories.ts:458-471 (handler)The handler function for the 'create-story-comment' tool. It validates the storyPublicId and text parameters, retrieves the story to confirm existence, creates the comment using the Shortcut client, and returns a success message with the comment URL.async createStoryComment({ storyPublicId, text }: { storyPublicId: number; text: string }) { if (!storyPublicId) throw new Error("Story public ID is required"); if (!text) throw new Error("Story comment text is required"); const story = await this.client.getStory(storyPublicId); if (!story) throw new Error(`Failed to retrieve Shortcut story with public ID: ${storyPublicId}`); const storyComment = await this.client.createStoryComment(storyPublicId, { text }); return this.toResult( `Created comment on story sc-${storyPublicId}. Comment URL: ${storyComment.app_url}.`, ); }
- src/tools/stories.ts:227-229 (schema)Input schema definition for the 'create-story-comment' tool using Zod: requires storyPublicId (positive number) and text (non-empty string).storyPublicId: z.number().positive().describe("The public ID of the story"), text: z.string().min(1).describe("The text of the comment"), },
- src/tools/stories.ts:223-231 (registration)Registration of the 'create-story-comment' MCP tool on the server, specifying name, description, input schema, and handler function.server.tool( "create-story-comment", "Create a comment on a story", { storyPublicId: z.number().positive().describe("The public ID of the story"), text: z.string().min(1).describe("The text of the comment"), }, async (params) => await tools.createStoryComment(params), );