Skip to main content
Glama
ampcome-mcps

Shortcut MCP Server

by ampcome-mcps

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
NameRequiredDescriptionDefault
storyPublicIdYesThe public ID of the story
textYesThe text of the comment

Implementation Reference

  • 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}.`,
    	);
    }
  • 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"),
    },
  • 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),
    );
Behavior2/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With no annotations provided, the description carries full burden for behavioral disclosure. While 'Create' implies a write operation, it doesn't specify permissions required, whether comments are editable/deletable, rate limits, or what happens on success/failure. This leaves significant behavioral gaps for a mutation tool.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is a single, efficient sentence that directly states the tool's purpose without unnecessary words. It's appropriately sized for a simple creation tool and front-loads the essential information.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a mutation tool with no annotations and no output schema, the description is insufficient. It doesn't address behavioral aspects like permissions, side effects, or response format. Given the complexity of creating content in what appears to be a project management system, more context about the operation's implications is needed.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, providing complete parameter documentation. The description adds no additional parameter semantics beyond what's in the schema (storyPublicId and text). This meets the baseline expectation when schema coverage is comprehensive.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the action ('Create') and target resource ('a comment on a story'), making the purpose immediately understandable. However, it doesn't differentiate from sibling tools like 'create-story' or 'add-task-to-story' that also create content on stories, leaving some ambiguity about when to choose this specific tool.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides no guidance on when to use this tool versus alternatives. With multiple sibling tools that create or add content to stories (e.g., 'create-story', 'add-task-to-story', 'add-external-link-to-story'), there's no indication of when a comment is the appropriate choice versus other story modifications.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/ampcome-mcps/shortcut-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server