Merge pull request #85 from useshortcut/amcd/upload-files-to-stories

Upload a file to a story.

Author: andreasmcdermott

package.json

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

src/client/shortcut.ts

@@ -1,3 +1,6 @@
+import { File } from "node:buffer";
+import { readFileSync } from "node:fs";
+import { basename } from "node:path";
 import type {
 	ShortcutClient as BaseClient,
 	CreateDoc,
@@ -536,6 +539,19 @@ export class ShortcutClientWrapper {
 		return doc;
 	}
 
+	async uploadFile(storyId: number, filePath: string) {
+		const fileContent = readFileSync(filePath);
+		const fileName = basename(filePath);
+		const file = new File([fileContent], fileName);
+		// biome-ignore lint/suspicious/noExplicitAny: I think the JS API expects a browser File.. but Node's File type is different, but compatible.
+		const response = await this.client.uploadFiles({ story_id: storyId, file0: file as any });
+		const uploadedFile = response?.data ?? null;
+
+		if (!uploadedFile?.length) throw new Error(`Failed to upload the file: ${response.status}`);
+
+		return uploadedFile[0];
+	}
+
 	async getCustomFieldMap(customFieldIds: string[]) {
 		await this.loadCustomFields();
 		return new Map(

src/tools/stories.test.ts

@@ -149,18 +149,19 @@ describe("StoryTools", () => {
 
 			StoryTools.create(mockClient, mockServer);
 
-			expect(mockTool).toHaveBeenCalledTimes(15);
+			expect(mockTool).toHaveBeenCalledTimes(16);
 			expect(mockTool.mock.calls?.[0]?.[0]).toBe("get-story");
 			expect(mockTool.mock.calls?.[1]?.[0]).toBe("search-stories");
 			expect(mockTool.mock.calls?.[2]?.[0]).toBe("get-story-branch-name");
 			expect(mockTool.mock.calls?.[3]?.[0]).toBe("create-story");
 			expect(mockTool.mock.calls?.[4]?.[0]).toBe("update-story");
-			expect(mockTool.mock.calls?.[5]?.[0]).toBe("assign-current-user-as-owner");
-			expect(mockTool.mock.calls?.[6]?.[0]).toBe("unassign-current-user-as-owner");
-			expect(mockTool.mock.calls?.[7]?.[0]).toBe("create-story-comment");
-			expect(mockTool.mock.calls?.[8]?.[0]).toBe("add-task-to-story");
-			expect(mockTool.mock.calls?.[9]?.[0]).toBe("add-relation-to-story");
-			expect(mockTool.mock.calls?.[10]?.[0]).toBe("update-task");
+			expect(mockTool.mock.calls?.[5]?.[0]).toBe("upload-file-to-story");
+			expect(mockTool.mock.calls?.[6]?.[0]).toBe("assign-current-user-as-owner");
+			expect(mockTool.mock.calls?.[7]?.[0]).toBe("unassign-current-user-as-owner");
+			expect(mockTool.mock.calls?.[8]?.[0]).toBe("create-story-comment");
+			expect(mockTool.mock.calls?.[9]?.[0]).toBe("add-task-to-story");
+			expect(mockTool.mock.calls?.[10]?.[0]).toBe("add-relation-to-story");
+			expect(mockTool.mock.calls?.[11]?.[0]).toBe("update-task");
 		});
 	});
 

src/tools/stories.ts

@@ -215,6 +215,16 @@ The story will be added to the default state for the workflow.
 			async (params) => await tools.updateStory(params),
 		);
 
+		server.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.tool(
 			"assign-current-user-as-owner",
 			"Assign the current user as the owner of a story",
@@ -530,6 +540,23 @@ The story will be added to the default state for the workflow.
 		return this.toResult(`Updated story sc-${storyPublicId}. Story URL: ${updatedStory.app_url}`);
 	}
 
+	async uploadFileToStory(storyPublicId: number, filePath: string) {
+		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,