@shortcut/mcp 0.2.1 → 0.4.0

package/README.md

@@ -51,8 +51,38 @@ See the [official Cursor docs](https://docs.cursor.com/context/model-context-pro
 }
 ```
 
+### Claude Code
+
+See the [official Claude Code docs](https://docs.anthropic.com/en/docs/agents-and-tools/claude-code/tutorials#set-up-model-context-protocol-mcp) for more information.
+
+_You can add a new MCP server from the Claude Code CLI. But modifying the json file directly is simpler!_
+
+1. Open the Claude Code configuration file (it should be in `~/.claude.json`).
+2. Find the `projects` > `mcpServers` section and add the following details and save the file:
+
+```json
+{
+  "projects": {
+    "mcpServers": {
+      "shortcut": {
+        "command": "npx",
+        "args": [
+          "-y",
+          "@shortcut/mcp"
+        ],
+        "env": {
+          "SHORTCUT_API_TOKEN": "<YOUR_SHORTCUT_API_TOKEN>"
+        }
+      }
+    }
+  }
+}
+```
+
 ## Issues and Troubleshooting
 
+Before doing anything else, please make sure you are running the latest version!
+
 If you run into problems using this MCP server, you have a couple of options:
 
 - Open an issue on [GitHub](https://github.com/useshortcut/mcp-server-shortcut/issues)

package/dist/index.js

@@ -14761,6 +14761,27 @@ class ShortcutClientWrapper {
       return { stories: null, total: null };
     return { stories, total: stories.length };
   }
+  async createStoryComment(storyPublicId, params) {
+    const response = await this.client.createStoryComment(storyPublicId, params);
+    const storyComment = response?.data ?? null;
+    if (!storyComment)
+      throw new Error(`Failed to create the comment: ${response.status}`);
+    return storyComment;
+  }
+  async createIteration(params) {
+    const response = await this.client.createIteration(params);
+    const iteration = response?.data ?? null;
+    if (!iteration)
+      throw new Error(`Failed to create the iteration: ${response.status}`);
+    return iteration;
+  }
+  async createEpic(params) {
+    const response = await this.client.createEpic(params);
+    const epic = response?.data ?? null;
+    if (!epic)
+      throw new Error(`Failed to create the epic: ${response.status}`);
+    return epic;
+  }
 }
 
 // node_modules/zod/lib/index.mjs
@@ -21304,7 +21325,7 @@ var import_client = __toESM(require_lib(), 1);
 
 // package.json
 var name = "@shortcut/mcp";
-var version = "0.2.1";
+var version = "0.4.0";
 
 // src/tools/base.ts
 class BaseTools {
@@ -21344,6 +21365,23 @@ var formatPullRequestList = (branches) => {
 var formatTaskList = (tasks) => {
   return formatAsUnorderedList((tasks || []).map((task) => `[${task.complete ? "X" : " "}] ${task.description}`), "Tasks");
 };
+var formatStats = (stats, showPoints) => {
+  const { num_stories_backlog, num_stories_unstarted, num_stories_started, num_stories_done } = stats;
+  const { num_points_backlog, num_points_unstarted, num_points_started, num_points_done } = stats;
+  const totalCount = num_stories_backlog + num_stories_unstarted + num_stories_started + num_stories_done;
+  const totalUnstarted = num_stories_backlog + num_stories_unstarted;
+  const totalPoints = (num_points_backlog || 0) + (num_points_unstarted || 0) + (num_points_started || 0) + (num_points_done || 0);
+  const totalUnstartedPoints = (num_points_backlog || 0) + (num_points_unstarted || 0);
+  const statsString = `Stats:
+- Total stories: ${totalCount}${showPoints ? ` (${totalPoints} points)` : ""}
+- Unstarted stories: ${totalUnstarted}${showPoints ? ` (${totalUnstartedPoints} points)` : ""}
+- Stories in progress: ${num_stories_started}${showPoints ? ` (${num_points_started || 0} points)` : ""}
+- Completed stories: ${num_stories_done}${showPoints ? ` (${num_points_done || 0} points)` : ""}`;
+  if (showPoints && stats.num_stories_unestimated)
+    return `${statsString}
+- (${stats.num_stories_unestimated} of the stories are unestimated)`;
+  return statsString;
+};
 
 // src/tools/utils/search.ts
 var getKey = (prop) => {
@@ -21425,6 +21463,11 @@ class EpicTools extends BaseTools {
       completed: date2,
       due: date2
     }, async (params) => await tools.searchEpics(params));
+    server.tool("create-epic", "Create a new Shortcut epic.", {
+      name: z.string().describe("The name of the epic"),
+      teamId: z.string().optional().describe("The ID of the team to assign the epic to"),
+      description: z.string().optional().describe("The description of the epic")
+    }, async (params) => await tools.createEpic(params));
     return tools;
   }
   async searchEpics(params) {
@@ -21442,6 +21485,8 @@ ${formatAsUnorderedList(epics.map((epic) => `${epic.id}: ${epic.name}`))}`);
     const epic = await this.client.getEpic(epicPublicId);
     if (!epic)
       throw new Error(`Failed to retrieve Shortcut epic with public ID: ${epicPublicId}`);
+    const currentUser = await this.client.getCurrentUser();
+    const showPoints = !!currentUser?.workspace2?.estimate_scale?.length;
     return this.toResult(`Epic: ${epicPublicId}
 URL: ${epic.app_url}
 Name: ${epic.name}
@@ -21452,9 +21497,24 @@ Due date: ${epic.deadline ? epic.deadline : "[Not set]"}
 Team: ${epic.group_id ? `${epic.group_id}` : "[None]"}
 Objective: ${epic.milestone_id ? `${epic.milestone_id}` : "[None]"}
 
+${formatStats(epic.stats, showPoints)}
+
 Description:
 ${epic.description}`);
   }
+  async createEpic({
+    name: name2,
+    teamId,
+    description
+  }) {
+    if (teamId) {
+      const team = await this.client.getTeam(teamId);
+      if (!team)
+        throw new Error(`Team with ID ${teamId} not found`);
+    }
+    const epic = await this.client.createEpic({ name: name2, group_id: teamId, description });
+    return this.toResult(`Epic created with ID: ${epic.id}.`);
+  }
 }
 
 // src/tools/iterations.ts
@@ -21476,6 +21536,13 @@ class IterationTools extends BaseTools {
       startDate: date2,
       endDate: date2
     }, async (params) => await tools.searchIterations(params));
+    server.tool("create-iteration", "Create a new Shortcut iteration", {
+      name: z.string().describe("The name of the iteration"),
+      description: z.string().optional().describe("The description of the iteration"),
+      startDate: z.string().describe("The start date of the iteration"),
+      endDate: z.string().describe("The end date of the iteration"),
+      teamId: z.string().optional().describe("The ID of the team to assign the iteration to")
+    }, async (params) => await tools.createIteration(params));
     return tools;
   }
   async getIterationStories(iterationPublicId) {
@@ -21501,6 +21568,8 @@ ${formatAsUnorderedList(iterations.map((iteration) => `${iteration.id}: ${iterat
     const iteration = await this.client.getIteration(iterationPublicId);
     if (!iteration)
       throw new Error(`Failed to retrieve Shortcut iteration with public ID: ${iterationPublicId}.`);
+    const currentUser = await this.client.getCurrentUser();
+    const showPoints = !!currentUser?.workspace2?.estimate_scale?.length;
     return this.toResult(`Iteration: ${iterationPublicId}
 Url: ${iteration.app_url}
 Name: ${iteration.name}
@@ -21510,9 +21579,34 @@ Completed: ${iteration.status === "completed" ? "Yes" : "No"}
 Started: ${iteration.status === "started" ? "Yes" : "No"}
 Team: ${iteration.group_ids?.length ? `${iteration.group_ids.join(", ")}` : "[None]"}
 
+${formatStats(iteration.stats, showPoints)}
+
 Description:
 ${iteration.description}`);
   }
+  async createIteration({
+    name: name2,
+    startDate,
+    endDate,
+    teamId,
+    description
+  }) {
+    if (teamId) {
+      const team = await this.client.getTeam(teamId);
+      if (!team)
+        throw new Error(`Team with ID ${teamId} not found`);
+    }
+    const iteration = await this.client.createIteration({
+      name: name2,
+      start_date: startDate,
+      end_date: endDate,
+      group_ids: teamId ? [teamId] : undefined,
+      description
+    });
+    if (!iteration)
+      throw new Error(`Failed to create the iteration.`);
+    return this.toResult(`Iteration created with ID: ${iteration.id}.`);
+  }
 }
 
 // src/tools/objectives.ts
@@ -21650,6 +21744,10 @@ The story will be added to the default state for the workflow.
     server.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.tool("create-story-comment", "Create a comment on a story", {
+      storyPublicId: z.number().positive().describe("The public ID of the story"),
+      text: z.string().min(1).describe("The text of the comment")
+    }, async (params) => await tools.createStoryComment(params));
     return tools;
   }
   async assignCurrentUserAsOwner(storyPublicId) {
@@ -21778,6 +21876,20 @@ ${comment.text || ""}`;
 
 `)}`);
   }
+  async createStoryComment({
+    storyPublicId,
+    text
+  }) {
+    if (!storyPublicId)
+      throw new Error("Story public ID is required");
+    if (!text)
+      throw new Error("Story comment text is required");
+    const story = await this.client.getStory(storyPublicId);
+    if (!story)
+      throw new Error(`Failed to retrieve Shortcut story with public ID: ${storyPublicId}`);
+    const storyComment = await this.client.createStoryComment(storyPublicId, { text });
+    return this.toResult(`Created comment on story sc-${storyPublicId}. Comment URL: ${storyComment.app_url}.`);
+  }
 }
 
 // src/tools/teams.ts
@@ -21869,7 +21981,7 @@ Default State: ${workflow.states.find((state) => state.id === workflow.default_s
 
 // src/server.ts
 var apiToken = process.env.SHORTCUT_API_TOKEN;
-if (process.argv.length > 2) {
+if (process.argv.length === 3) {
   const [name2, token] = String(process.argv[2]).split("=");
   if (name2 === "SHORTCUT_API_TOKEN")
     apiToken = token;

package/package.json

@@ -8,7 +8,7 @@
 	},
 	"keywords": ["shortcut", "mcp", "modelcontextprotocol"],
 	"license": "MIT",
-	"version": "0.2.1",
+	"version": "0.4.0",
 	"type": "module",
 	"main": "dist/index.js",
 	"bin": {