Skip to main content
Glama
ampcome-mcps

Shortcut MCP Server

by ampcome-mcps

get-story

Retrieve a Shortcut story using its public ID to access project management details and information.

Instructions

Get a Shortcut story by public ID

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
storyPublicIdYesThe public ID of the story to get

Implementation Reference

  • The handler function for the 'get-story' tool. It fetches the story using the Shortcut client, throws an error if not found, and returns a formatted result using toResult and entityWithRelatedEntities.
    async getStory(storyPublicId: number) {
    	const story = await this.client.getStory(storyPublicId);
    
    	if (!story)
    		throw new Error(`Failed to retrieve Shortcut story with public ID: ${storyPublicId}.`);
    
    	return this.toResult(
    		`Story: sc-${storyPublicId}`,
    		await this.entityWithRelatedEntities(story, "story"),
    	);
    }
  • Registration of the 'get-story' MCP tool using server.tool, specifying name, description, input schema, and handler.
    server.tool(
    	"get-story",
    	"Get a Shortcut story by public ID",
    	{
    		storyPublicId: z.number().positive().describe("The public ID of the story to get"),
    	},
    	async ({ storyPublicId }) => await tools.getStory(storyPublicId),
    );
  • Zod input schema for the 'get-story' tool, validating storyPublicId as a positive number.
    {
    	storyPublicId: z.number().positive().describe("The public ID of the story to get"),
    },
Behavior2/5

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

No annotations are provided, so the description carries the full burden of behavioral disclosure. It states the tool retrieves a story but doesn't describe what information is returned, whether it's a read-only operation, potential error conditions, or any rate limits. For a retrieval tool with zero annotation coverage, this leaves significant gaps in understanding how the tool behaves beyond its basic purpose.

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 front-loads the essential information: 'Get a Shortcut story by public ID'. There is no wasted language, repetition, or unnecessary elaboration. Every word earns its place by contributing directly to understanding the tool's purpose.

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?

Given the lack of annotations and output schema, the description is incomplete for effective tool use. It doesn't explain what data is returned (e.g., story details, error formats), behavioral aspects like read-only nature, or how it differs from similar tools. For a retrieval tool in a context with multiple sibling tools, more contextual information is needed to guide the agent appropriately.

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?

The input schema has 100% description coverage, with the single parameter 'storyPublicId' clearly documented as 'The public ID of the story to get'. The description adds no additional parameter information beyond what the schema provides, such as format examples or constraints. With high schema coverage, the baseline score of 3 is appropriate as the schema handles the parameter documentation adequately.

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 ('Get') and resource ('a Shortcut story by public ID'), making the purpose immediately understandable. It doesn't explicitly differentiate from sibling tools like 'get-epic' or 'get-iteration', but the specificity of 'story' and 'public ID' provides adequate distinction. The description avoids tautology by not simply restating the tool name.

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. It doesn't mention sibling tools like 'search-stories' or 'get-stories-by-external-link' that might serve similar purposes, nor does it specify prerequisites or contexts where this tool is preferred. The agent must infer usage solely from the tool name and description without explicit direction.

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