@shortcut/mcp 0.12.0 → 0.12.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +62 -0
- package/dist/index.js +9 -9
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -125,6 +125,68 @@ Or you can edit the local JSON file directly:
|
|
|
125
125
|
}
|
|
126
126
|
```
|
|
127
127
|
|
|
128
|
+
## Available Tools
|
|
129
|
+
|
|
130
|
+
### Stories
|
|
131
|
+
|
|
132
|
+
- **get-story** - Get a single Shortcut story by ID
|
|
133
|
+
- **search-stories** - Find Shortcut stories with filtering and search options
|
|
134
|
+
- **get-story-branch-name** - Get the recommended branch name (based on workspace settings) for a specific story.
|
|
135
|
+
- **create-story** - Create a new Shortcut story
|
|
136
|
+
- **update-story** - Update an existing Shortcut story
|
|
137
|
+
- **upload-file-to-story** - Upload a file and link it to a story
|
|
138
|
+
- **assign-current-user-as-owner** - Assign the current user as the owner of a story
|
|
139
|
+
- **unassign-current-user-as-owner** - Unassign the current user as the owner of a story
|
|
140
|
+
- **create-story-comment** - Create a comment on a story
|
|
141
|
+
- **add-task-to-story** - Add a task to a story
|
|
142
|
+
- **update-task** - Update a task in a story
|
|
143
|
+
- **add-relation-to-story** - Add a story relationship (relates to, blocks, duplicates, etc.)
|
|
144
|
+
- **add-external-link-to-story** - Add an external link to a Shortcut story
|
|
145
|
+
- **remove-external-link-from-story** - Remove an external link from a Shortcut story
|
|
146
|
+
- **get-stories-by-external-link** - Find all stories that contain a specific external link
|
|
147
|
+
- **set-story-external-links** - Replace all external links on a story with a new set of links
|
|
148
|
+
|
|
149
|
+
### Epics
|
|
150
|
+
|
|
151
|
+
- **get-epic** - Get a Shortcut epic by ID
|
|
152
|
+
- **search-epics** - Find Shortcut epics with filtering and search options
|
|
153
|
+
- **create-epic** - Create a new Shortcut epic
|
|
154
|
+
|
|
155
|
+
### Iterations
|
|
156
|
+
|
|
157
|
+
- **get-iteration-stories** - Get stories in a specific iteration by iteration ID
|
|
158
|
+
- **get-iteration** - Get a Shortcut iteration by ID
|
|
159
|
+
- **search-iterations** - Find Shortcut iterations with filtering and search options
|
|
160
|
+
- **create-iteration** - Create a new Shortcut iteration with start/end dates
|
|
161
|
+
- **get-active-iterations** - Get active iterations for the current user based on team memberships
|
|
162
|
+
- **get-upcoming-iterations** - Get upcoming iterations for the current user based on team memberships
|
|
163
|
+
|
|
164
|
+
### Objectives
|
|
165
|
+
|
|
166
|
+
- **get-objective** - Get a Shortcut objective by ID
|
|
167
|
+
- **search-objectives** - Find Shortcut objectives with filtering and search options
|
|
168
|
+
|
|
169
|
+
### Teams
|
|
170
|
+
|
|
171
|
+
- **get-team** - Get a Shortcut team by ID
|
|
172
|
+
- **list-teams** - List all Shortcut teams
|
|
173
|
+
|
|
174
|
+
### Workflows
|
|
175
|
+
|
|
176
|
+
- **get-default-workflow** - Get the default workflow for a specific team or the workspace default
|
|
177
|
+
- **get-workflow** - Get a Shortcut workflow by ID
|
|
178
|
+
- **list-workflows** - List all Shortcut workflows
|
|
179
|
+
|
|
180
|
+
### Users
|
|
181
|
+
|
|
182
|
+
- **get-current-user** - Get the current user information
|
|
183
|
+
- **get-current-user-teams** - Get a list of teams where the current user is a member
|
|
184
|
+
- **list-users** - Get all workspace users
|
|
185
|
+
|
|
186
|
+
### Documents
|
|
187
|
+
|
|
188
|
+
- **create-document** - Create a new document in Shortcut with HTML content
|
|
189
|
+
|
|
128
190
|
## Issues and Troubleshooting
|
|
129
191
|
|
|
130
192
|
Before doing anything else, please make sure you are running the latest version!
|
package/dist/index.js
CHANGED
|
@@ -450,7 +450,7 @@ var ShortcutClientWrapper = class {
|
|
|
450
450
|
//#endregion
|
|
451
451
|
//#region package.json
|
|
452
452
|
var name = "@shortcut/mcp";
|
|
453
|
-
var version = "0.12.
|
|
453
|
+
var version = "0.12.1";
|
|
454
454
|
|
|
455
455
|
//#endregion
|
|
456
456
|
//#region src/tools/base.ts
|
|
@@ -1224,6 +1224,13 @@ The story will be added to the default state for the workflow.
|
|
|
1224
1224
|
taskDescription: z.string().min(1).describe("The description of the task"),
|
|
1225
1225
|
taskOwnerIds: z.array(z.string()).optional().describe("Array of user IDs to assign as owners of the task")
|
|
1226
1226
|
}, async (params) => await tools.addTaskToStory(params));
|
|
1227
|
+
server$1.tool("update-task", "Update a task in a story", {
|
|
1228
|
+
storyPublicId: z.number().positive().describe("The public ID of the story"),
|
|
1229
|
+
taskPublicId: z.number().positive().describe("The public ID of the task"),
|
|
1230
|
+
taskDescription: z.string().optional().describe("The description of the task"),
|
|
1231
|
+
taskOwnerIds: z.array(z.string()).optional().describe("Array of user IDs to assign as owners of the task"),
|
|
1232
|
+
isCompleted: z.boolean().optional().describe("Whether the task is completed or not")
|
|
1233
|
+
}, async (params) => await tools.updateTask(params));
|
|
1227
1234
|
server$1.tool("add-relation-to-story", "Add a story relationship to a story", {
|
|
1228
1235
|
storyPublicId: z.number().positive().describe("The public ID of the story"),
|
|
1229
1236
|
relatedStoryPublicId: z.number().positive().describe("The public ID of the related story"),
|
|
@@ -1235,13 +1242,6 @@ The story will be added to the default state for the workflow.
|
|
|
1235
1242
|
"duplicated by"
|
|
1236
1243
|
]).optional().default("relates to").describe("The type of relationship")
|
|
1237
1244
|
}, async (params) => await tools.addRelationToStory(params));
|
|
1238
|
-
server$1.tool("update-task", "Update a task in a story", {
|
|
1239
|
-
storyPublicId: z.number().positive().describe("The public ID of the story"),
|
|
1240
|
-
taskPublicId: z.number().positive().describe("The public ID of the task"),
|
|
1241
|
-
taskDescription: z.string().optional().describe("The description of the task"),
|
|
1242
|
-
taskOwnerIds: z.array(z.string()).optional().describe("Array of user IDs to assign as owners of the task"),
|
|
1243
|
-
isCompleted: z.boolean().optional().describe("Whether the task is completed or not")
|
|
1244
|
-
}, async (params) => await tools.updateTask(params));
|
|
1245
1245
|
server$1.tool("add-external-link-to-story", "Add an external link to a Shortcut story", {
|
|
1246
1246
|
storyPublicId: z.number().positive().describe("The public ID of the story"),
|
|
1247
1247
|
externalLink: z.string().url().max(2048).describe("The external link URL to add")
|
|
@@ -1461,7 +1461,7 @@ var UserTools = class UserTools extends BaseTools {
|
|
|
1461
1461
|
const tools = new UserTools(client$1);
|
|
1462
1462
|
server$1.tool("get-current-user", "Get the current user", async () => await tools.getCurrentUser());
|
|
1463
1463
|
server$1.tool("get-current-user-teams", "Get a list of teams where the current user is a member", async () => await tools.getCurrentUserTeams());
|
|
1464
|
-
server$1.tool("list-
|
|
1464
|
+
server$1.tool("list-users", "Get all users", async () => await tools.listMembers());
|
|
1465
1465
|
return tools;
|
|
1466
1466
|
}
|
|
1467
1467
|
async getCurrentUser() {
|