Skip to main content
Glama
useshortcut

Shortcut MCP Server

Official
by useshortcut

stories-get-branch-name

Generate valid Git branch names from Shortcut story IDs to maintain consistent naming conventions in development workflows.

Instructions

Get a valid branch name for a specific story.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
storyPublicIdYesThe public Id of the story

Implementation Reference

  • Handler function that implements the tool logic: fetches current user and story, uses existing branch name if available or generates one via createBranchName, and returns it.
    async getStoryBranchName(storyPublicId: number) {
    	const currentUser = await this.client.getCurrentUser();
    	if (!currentUser) throw new Error("Unable to find current user");
    
    	const story = await this.client.getStory(storyPublicId);
    
    	if (!story)
    		throw new Error(`Failed to retrieve Shortcut story with public ID: ${storyPublicId}`);
    
    	const branchName =
    		(story as Story & { formatted_vcs_branch_name: string | null }).formatted_vcs_branch_name ||
    		this.createBranchName(currentUser, story);
    	return this.toResult(`Branch name for story sc-${storyPublicId}: ${branchName}`);
    }
  • Registers the 'stories-get-branch-name' tool with MCP server, including input schema and handler reference.
    server.addToolWithReadAccess(
    	"stories-get-branch-name",
    	"Get a valid branch name for a specific story.",
    	{
    		storyPublicId: z.number().positive().describe("The public Id of the story"),
    	},
    	async ({ storyPublicId }) => await tools.getStoryBranchName(storyPublicId),
    );
  • Helper function to generate a formatted branch name from user mention name, story ID, and sanitized story name.
    private createBranchName(currentUser: MemberInfo, story: Story) {
    	return `${currentUser.mention_name}/sc-${story.id}/${story.name
    		.toLowerCase()
    		.replace(/\s+/g, "-")
    		.replace(/[^\w-]/g, "")}`.substring(0, 50);
    }

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