Skip to main content
Glama
useshortcut

Shortcut MCP Server

Official
by useshortcut

stories-set-external-links

Replace all external links on a Shortcut story with a new set of URLs to update references and resources.

Instructions

Replace all external links on a story with a new set of links

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
storyPublicIdYesThe public ID of the story
externalLinksYesArray of external link URLs to set (replaces all existing links)

Implementation Reference

  • Registration of the 'stories-set-external-links' tool, including input schema validation using Zod and reference to the handler method.
    server.addToolWithWriteAccess(
    	"stories-set-external-links",
    	"Replace all external links on a story with a new set of links",
    	{
    		storyPublicId: z.number().positive().describe("The public ID of the story"),
    		externalLinks: z
    			.array(z.string().url().max(2048))
    			.describe("Array of external link URLs to set (replaces all existing links)"),
    	},
    	async ({ storyPublicId, externalLinks }) =>
    		await tools.setStoryExternalLinks(storyPublicId, externalLinks),
    );
  • The main handler function for the 'stories-set-external-links' tool. It validates inputs, calls the Shortcut client to set the external links on the story, and returns a success message with the story URL.
    async setStoryExternalLinks(storyPublicId: number, externalLinks: string[]) {
    	if (!storyPublicId) throw new Error("Story public ID is required");
    	if (!Array.isArray(externalLinks)) throw new Error("External links must be an array");
    
    	const updatedStory = await this.client.setStoryExternalLinks(storyPublicId, externalLinks);
    
    	const linkCount = externalLinks.length;
    	const message =
    		linkCount === 0
    			? `Removed all external links from story sc-${storyPublicId}`
    			: `Set ${linkCount} external link${linkCount === 1 ? "" : "s"} on story sc-${storyPublicId}`;
    
    	return this.toResult(`${message}. Story URL: ${updatedStory.app_url}`);
    }
  • Input schema for the 'stories-set-external-links' tool using Zod for validation of storyPublicId and externalLinks array.
    {
    	storyPublicId: z.number().positive().describe("The public ID of the story"),
    	externalLinks: z
    		.array(z.string().url().max(2048))
    		.describe("Array of external link URLs to set (replaces all existing links)"),
    },
Behavior2/5

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

With no annotations provided, the description carries the full burden of behavioral disclosure. It states this is a replacement operation ('replaces all existing links'), which implies a destructive mutation, but doesn't clarify whether this requires specific permissions, if changes are reversible, or what happens to the story's state. The description adds minimal behavioral context beyond the basic action.

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 core action ('Replace all external links on a story') and adds clarifying detail ('with a new set of links'). There's zero wasted verbiage, making it highly concise and well-structured.

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, reversibility, or error conditions, nor does it explain what the tool returns. Given the complexity of a destructive replace operation, more context is needed for safe and effective use.

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%, so the schema already fully documents both parameters. The description adds marginal value by emphasizing that 'externalLinks' replaces all existing links, but doesn't provide additional semantics beyond what's in the schema descriptions. Baseline 3 is appropriate when the schema does the heavy lifting.

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 ('Replace all external links') and the resource ('on a story'), making the purpose immediately understandable. However, it doesn't explicitly differentiate from sibling tools like 'stories-add-external-link' or 'stories-remove-external-link' beyond the 'replace all' phrasing.

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 like 'stories-add-external-link' or 'stories-remove-external-link'. It also doesn't mention prerequisites, such as needing an existing story or appropriate permissions.

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/useshortcut/mcp-server-shortcut'

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