@shortcut/mcp 0.11.2 → 0.12.1

package/README.md

@@ -125,6 +125,68 @@ Or you can edit the local JSON file directly:
   }
 ```
 
+## Available Tools
+
+### Stories
+
+- **get-story** - Get a single Shortcut story by ID
+- **search-stories** - Find Shortcut stories with filtering and search options
+- **get-story-branch-name** - Get the recommended branch name (based on workspace settings) for a specific story.
+- **create-story** - Create a new Shortcut story
+- **update-story** - Update an existing Shortcut story
+- **upload-file-to-story** - Upload a file and link it to a story
+- **assign-current-user-as-owner** - Assign the current user as the owner of a story
+- **unassign-current-user-as-owner** - Unassign the current user as the owner of a story
+- **create-story-comment** - Create a comment on a story
+- **add-task-to-story** - Add a task to a story
+- **update-task** - Update a task in a story
+- **add-relation-to-story** - Add a story relationship (relates to, blocks, duplicates, etc.)
+- **add-external-link-to-story** - Add an external link to a Shortcut story
+- **remove-external-link-from-story** - Remove an external link from a Shortcut story
+- **get-stories-by-external-link** - Find all stories that contain a specific external link
+- **set-story-external-links** - Replace all external links on a story with a new set of links
+
+### Epics
+
+- **get-epic** - Get a Shortcut epic by ID
+- **search-epics** - Find Shortcut epics with filtering and search options
+- **create-epic** - Create a new Shortcut epic
+
+### Iterations
+
+- **get-iteration-stories** - Get stories in a specific iteration by iteration ID
+- **get-iteration** - Get a Shortcut iteration by ID
+- **search-iterations** - Find Shortcut iterations with filtering and search options
+- **create-iteration** - Create a new Shortcut iteration with start/end dates
+- **get-active-iterations** - Get active iterations for the current user based on team memberships
+- **get-upcoming-iterations** - Get upcoming iterations for the current user based on team memberships
+
+### Objectives
+
+- **get-objective** - Get a Shortcut objective by ID
+- **search-objectives** - Find Shortcut objectives with filtering and search options
+
+### Teams
+
+- **get-team** - Get a Shortcut team by ID
+- **list-teams** - List all Shortcut teams
+
+### Workflows
+
+- **get-default-workflow** - Get the default workflow for a specific team or the workspace default
+- **get-workflow** - Get a Shortcut workflow by ID
+- **list-workflows** - List all Shortcut workflows
+
+### Users
+
+- **get-current-user** - Get the current user information
+- **get-current-user-teams** - Get a list of teams where the current user is a member
+- **list-users** - Get all workspace users
+
+### Documents
+
+- **create-document** - Create a new document in Shortcut with HTML content
+
 ## Issues and Troubleshooting
 
 Before doing anything else, please make sure you are running the latest version!

package/dist/index.js

@@ -2,6 +2,9 @@
 import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
 import { StdioServerTransport } from "@modelcontextprotocol/sdk/server/stdio.js";
 import { ShortcutClient } from "@shortcut/client";
+import { File } from "node:buffer";
+import { readFileSync } from "node:fs";
+import { basename } from "node:path";
 import { z } from "zod";
 
 //#region src/client/cache.ts
@@ -422,6 +425,18 @@ var ShortcutClientWrapper = class {
 		if (!doc) throw new Error(`Failed to create the document: ${response.status}`);
 		return doc;
 	}
+	async uploadFile(storyId, filePath) {
+		const fileContent = readFileSync(filePath);
+		const fileName = basename(filePath);
+		const file = new File([fileContent], fileName);
+		const response = await this.client.uploadFiles({
+			story_id: storyId,
+			file0: file
+		});
+		const uploadedFile = response?.data ?? null;
+		if (!uploadedFile?.length) throw new Error(`Failed to upload the file: ${response.status}`);
+		return uploadedFile[0];
+	}
 	async getCustomFieldMap(customFieldIds) {
 		await this.loadCustomFields();
 		return new Map(customFieldIds.map((id) => [id, this.customFieldCache.get(id)]).filter((customField) => customField[1] !== null));
@@ -435,7 +450,7 @@ var ShortcutClientWrapper = class {
 //#endregion
 //#region package.json
 var name = "@shortcut/mcp";
-var version = "0.11.2";
+var version = "0.12.1";
 
 //#endregion
 //#region src/tools/base.ts
@@ -1194,6 +1209,10 @@ The story will be added to the default state for the workflow.
 				description: z.string().optional().describe("The description of the label")
 			})).optional().describe("Labels to assign to the story")
 		}, async (params) => await tools.updateStory(params));
+		server$1.tool("upload-file-to-story", "Upload a file and link it to a story.", {
+			storyPublicId: z.number().positive().describe("The public ID of the story"),
+			filePath: z.string().describe("The path to the file to upload")
+		}, async ({ storyPublicId, filePath }) => await tools.uploadFileToStory(storyPublicId, filePath));
 		server$1.tool("assign-current-user-as-owner", "Assign the current user as the owner of a story", { storyPublicId: z.number().positive().describe("The public ID of the story") }, async ({ storyPublicId }) => await tools.assignCurrentUserAsOwner(storyPublicId));
 		server$1.tool("unassign-current-user-as-owner", "Unassign the current user as the owner of a story", { storyPublicId: z.number().positive().describe("The public ID of the story") }, async ({ storyPublicId }) => await tools.unassignCurrentUserAsOwner(storyPublicId));
 		server$1.tool("create-story-comment", "Create a comment on a story", {
@@ -1205,6 +1224,13 @@ The story will be added to the default state for the workflow.
 			taskDescription: z.string().min(1).describe("The description of the task"),
 			taskOwnerIds: z.array(z.string()).optional().describe("Array of user IDs to assign as owners of the task")
 		}, async (params) => await tools.addTaskToStory(params));
+		server$1.tool("update-task", "Update a task in a story", {
+			storyPublicId: z.number().positive().describe("The public ID of the story"),
+			taskPublicId: z.number().positive().describe("The public ID of the task"),
+			taskDescription: z.string().optional().describe("The description of the task"),
+			taskOwnerIds: z.array(z.string()).optional().describe("Array of user IDs to assign as owners of the task"),
+			isCompleted: z.boolean().optional().describe("Whether the task is completed or not")
+		}, async (params) => await tools.updateTask(params));
 		server$1.tool("add-relation-to-story", "Add a story relationship to a story", {
 			storyPublicId: z.number().positive().describe("The public ID of the story"),
 			relatedStoryPublicId: z.number().positive().describe("The public ID of the related story"),
@@ -1216,13 +1242,6 @@ The story will be added to the default state for the workflow.
 				"duplicated by"
 			]).optional().default("relates to").describe("The type of relationship")
 		}, async (params) => await tools.addRelationToStory(params));
-		server$1.tool("update-task", "Update a task in a story", {
-			storyPublicId: z.number().positive().describe("The public ID of the story"),
-			taskPublicId: z.number().positive().describe("The public ID of the task"),
-			taskDescription: z.string().optional().describe("The description of the task"),
-			taskOwnerIds: z.array(z.string()).optional().describe("Array of user IDs to assign as owners of the task"),
-			isCompleted: z.boolean().optional().describe("Whether the task is completed or not")
-		}, async (params) => await tools.updateTask(params));
 		server$1.tool("add-external-link-to-story", "Add an external link to a Shortcut story", {
 			storyPublicId: z.number().positive().describe("The public ID of the story"),
 			externalLink: z.string().url().max(2048).describe("The external link URL to add")
@@ -1326,6 +1345,15 @@ The story will be added to the default state for the workflow.
 		const updatedStory = await this.client.updateStory(storyPublicId, updateParams);
 		return this.toResult(`Updated story sc-${storyPublicId}. Story URL: ${updatedStory.app_url}`);
 	}
+	async uploadFileToStory(storyPublicId, filePath) {
+		if (!storyPublicId) throw new Error("Story public ID is required");
+		if (!filePath) throw new Error("File path is required");
+		const story = await this.client.getStory(storyPublicId);
+		if (!story) throw new Error(`Failed to retrieve Shortcut story with public ID: ${storyPublicId}`);
+		const uploadedFile = await this.client.uploadFile(storyPublicId, filePath);
+		if (!uploadedFile) throw new Error(`Failed to upload file to story sc-${storyPublicId}`);
+		return this.toResult(`Uploaded file "${uploadedFile.name}" to story sc-${storyPublicId}. File ID is: ${uploadedFile.id}`);
+	}
 	async addTaskToStory({ storyPublicId, taskDescription, taskOwnerIds }) {
 		if (!storyPublicId) throw new Error("Story public ID is required");
 		if (!taskDescription) throw new Error("Task description is required");
@@ -1433,7 +1461,7 @@ var UserTools = class UserTools extends BaseTools {
 		const tools = new UserTools(client$1);
 		server$1.tool("get-current-user", "Get the current user", async () => await tools.getCurrentUser());
 		server$1.tool("get-current-user-teams", "Get a list of teams where the current user is a member", async () => await tools.getCurrentUserTeams());
-		server$1.tool("list-members", "Get all members", async () => await tools.listMembers());
+		server$1.tool("list-users", "Get all users", async () => await tools.listMembers());
 		return tools;
 	}
 	async getCurrentUser() {

package/package.json

@@ -12,7 +12,7 @@
 		"modelcontextprotocol"
 	],
 	"license": "MIT",
-	"version": "0.11.2",
+	"version": "0.12.1",
 	"type": "module",
 	"main": "dist/index.js",
 	"bin": {