@shortcut/mcp 0.1.0 → 0.1.2

package/README.md

@@ -1,26 +1,7 @@
-# @useshortcut/mcp
-
-> [!IMPORTANT]
-> To use the MCP server, you need to first install the dependencies and run the build step.
-
-## Installation
-
-> First - install **bun** if needed: [Bun](https://bun.sh).
-
-```bash
-bun install
-```
-
-## Build
-
-```bash
-bun run build
-```
+# @shortcut/mcp
 
 ## Usage
 
-> Note: `mcp-server-shortcut` in the paths below refer to the folder name where you cloned this repo. If you used a different folder name, you'll need to use that instead.
-
 ### Windsurf
 
 See the [official Windsurf docs](https://codeium.com/docs/windsurf/mcp) for more information.
@@ -33,9 +14,9 @@ See the [official Windsurf docs](https://codeium.com/docs/windsurf/mcp) for more
 {
   "mcpServers": {
     "shortcut": {
-      "command": "node",
+      "command": "npx",
       "args": [
-        "/path/to/this/repo/mcp-server-shortcut"
+        "@shortcut/mcp"
       ],
       "env": {
         "SHORTCUT_API_TOKEN": "<YOUR_SHORTCUT_API_TOKEN>"
@@ -56,9 +37,9 @@ See the [official Cursor docs](https://docs.cursor.com/context/model-context-pro
 {
   "mcpServers": {
     "shortcut": {
-      "command": "node",
+      "command": "npx",
       "args": [
-        "/path/to/this/repo/mcp-server-shortcut"
+        "@shortcut/mcp"
       ],
       "env": {
         "SHORTCUT_API_TOKEN": "<YOUR_SHORTCUT_API_TOKEN>"
@@ -66,4 +47,18 @@ See the [official Cursor docs](https://docs.cursor.com/context/model-context-pro
     }
   }
 }
+```
+
+## Development
+
+## Installation
+
+```bash
+npm install
+```
+
+## Build
+
+```bash
+npm run build
 ```

package/dist/index.js

@@ -1,5 +1,4 @@
-#!/usr/bin/env bun
-// @bun
+#!/usr/bin/env node
 import { createRequire } from "node:module";
 var __create = Object.create;
 var __getProtoOf = Object.getPrototypeOf;
@@ -16457,8 +16456,8 @@ var require_lib = __commonJS((exports) => {
 });
 
 // package.json
-var name = "@useshortcut/mcp";
-var version = "0.0.0";
+var name = "@shortcut/mcp";
+var version = "0.1.0";
 
 // node_modules/zod/lib/index.mjs
 var util;
@@ -23692,11 +23691,13 @@ var formatStoryList = (stories, users) => {
 	return stories
 		.map(
 			(story) =>
-				`- sc-${story.id}: ${story.name} (Type: ${story.story_type}, State: ${story.completed ? "Completed" : story.started ? "In Progress" : "Not Started"}, Owners: ${story.owner_ids
-					.map((ownerId) => users.get(ownerId))
-					.filter((owner) => owner !== null)
-					.map((owner) => `@${owner.profile.mention_name}`)
-					.join(", ")})`,
+				`- sc-${story.id}: ${story.name} (Type: ${story.story_type}, State: ${story.completed ? "Completed" : story.started ? "In Progress" : "Not Started"}, Team: ${story.group_id ? `${story.group_id}` : "[None]"}, Epic: ${story.epic_id ? `${story.epic_id}` : "[None]"}, Iteration: ${story.iteration_id ? `${story.iteration_id}` : "[None]"}, Owners: ${
+					story.owner_ids
+						.map((ownerId) => users.get(ownerId))
+						.filter((owner) => owner !== null)
+						.map((owner) => `@${owner.profile.mention_name}`)
+						.join(", ") || "[None]"
+				})`,
 		)
 		.join(`
 `);
@@ -23881,7 +23882,7 @@ class StoryTools extends BaseTools {
 				isUnstarted: is("unstarted"),
 				isUnestimated: is("unestimated"),
 				isOverdue: is("overdue"),
-				isArchived: is("archived"),
+				isArchived: is("archived").default(false),
 				isBlocker: is("blocking"),
 				isBlocked: is("blocked"),
 				hasComment: has("a comment"),
@@ -23970,19 +23971,20 @@ The story will be added to the default state for the workflow.
 		});
 		return this.toResult(`Unassigned current user as owner of story sc-${storyPublicId}`);
 	}
+	createBranchName(currentUser, story) {
+		return `${currentUser.mention_name}/sc-${story.id}/${story.name
+			.toLowerCase()
+			.replace(/\s+/g, "-")
+			.replace(/[^\w\-]/g, "")}`.substring(0, 50);
+	}
 	async getStoryBranchName(storyPublicId) {
 		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 = `${currentUser.mention_name}/sc-${storyPublicId}/${story.name
-			.toLowerCase()
-			.replace(/\s+/g, "-")
-			.replace(/[^\w\-]/g, "")}`;
-		return this.toResult(
-			`Branch name for story sc-${storyPublicId}: ${branchName.substring(0, 50)}`,
-		);
+		const branchName = story.formatted_vcs_branch_name || this.createBranchName(currentUser, story);
+		return this.toResult(`Branch name for story sc-${storyPublicId}: ${branchName}`);
 	}
 	async createStory({ name: name2, description, type, owner, epic, team, workflow }) {
 		if (!workflow && !team) throw new Error("Team or Workflow has to be specified");
@@ -24018,7 +24020,11 @@ ${formatStoryList(stories, users)}`);
 		const story = await this.client.getStory(storyPublicId);
 		if (!story)
 			throw new Error(`Failed to retrieve Shortcut story with public ID: ${storyPublicId}.`);
-		const owners = await this.client.getUserMap(story.owner_ids);
+		const relatedUsers = new Set([
+			...story.owner_ids,
+			...story.comments.flatMap((c) => c.author_id),
+		]);
+		const users = await this.client.getUserMap([...relatedUsers].filter((id) => !!id));
 		return this.toResult(`Story: sc-${storyPublicId}
 URL: ${story.app_url}
 Name: ${story.name}
@@ -24029,22 +24035,28 @@ Started: ${story.started ? "Yes" : "No"}
 Blocked: ${story.blocked ? "Yes" : "No"}
 Blocking: ${story.blocker ? "Yes" : "No"}
 Due date: ${story.deadline ? story.deadline : "[None]"}
+Team: ${story.group_id ? `${story.group_id}` : "[None]"}
 Owners:${
 			story.owner_ids.length
 				? `
-${formatMemberList(story.owner_ids, owners)}`
+${formatMemberList(story.owner_ids, users)}`
 				: " [None]"
 		}
+Epic: ${story.epic_id ? `${story.epic_id}` : "[None]"}
+Iteration: ${story.iteration_id ? `${story.iteration_id}` : "[None]"}
 
 Description:
 ${story.description}
 
 Comments:
 ${(story.comments || [])
-	.map(
-		(comment) => `- From: ${comment.author_id} on ${comment.created_at}.
-${comment.text || ""}`,
-	)
+	.map((comment) => {
+		const mentionName = comment.author_id
+			? users.get(comment.author_id)?.profile?.mention_name
+			: null;
+		return `- From: ${mentionName ? `@${mentionName}` : `id=${comment.author_id}` || "[Unknown]"} on ${comment.created_at}.
+${comment.text || ""}`;
+	})
 	.join(`
 
 `)}`);
@@ -24112,7 +24124,7 @@ class EpicTools extends BaseTools {
 				isUnstarted: is("unstarted"),
 				isStarted: is("started"),
 				isDone: is("completed"),
-				isArchived: is("archived"),
+				isArchived: is("archived").default(false),
 				isOverdue: is("overdue"),
 				hasOwner: has("an owner"),
 				hasComment: has("a comment"),
@@ -24149,6 +24161,8 @@ Archived: ${epic.archived ? "Yes" : "No"}
 Completed: ${epic.completed ? "Yes" : "No"}
 Started: ${epic.started ? "Yes" : "No"}
 Due date: ${epic.deadline ? epic.deadline : "[Not set]"}
+Team: ${epic.group_id ? `${epic.group_id}` : "[None]"}
+Objective: ${epic.milestone_id ? `${epic.milestone_id}` : "[None]"}
 
 Description:
 ${epic.description}`);
@@ -24315,6 +24329,7 @@ Start date: ${iteration.start_date}
 End date: ${iteration.end_date}
 Completed: ${iteration.status === "completed" ? "Yes" : "No"}
 Started: ${iteration.status === "started" ? "Yes" : "No"}
+Team: ${iteration.group_ids?.length ? `${iteration.group_ids.join(", ")}` : "[None]"}
 
 Description:
 ${iteration.description}`);

package/package.json

@@ -1,20 +1,23 @@
 {
 	"name": "@shortcut/mcp",
+	"author": "Shortcut (https://www.shortcut.com)",
 	"repository": {
 		"type": "git",
 		"url": "https://github.com/useshortcut/mcp-server-shortcut.git"
 	},
 	"keywords": ["shortcut", "mcp", "modelcontextprotocol"],
 	"license": "MIT",
-	"version": "0.1.0",
+	"version": "0.1.2",
 	"type": "module",
-	"private": false,
 	"main": "dist/index.js",
-	"bin": "dist/shortcut-mcp",
-	"files": ["dist", "README.md", "LICENSE"],
+	"bin": {
+		"mcp-server-shortcut": "dist/index.js"
+	},
+	"files": ["dist"],
 	"devDependencies": {
 		"@biomejs/biome": "^1.9.4",
 		"@types/bun": "latest",
+		"bun": "^1.2.5",
 		"husky": "^9.1.7",
 		"shx": "^0.3.4"
 	},