@shortcut/mcp 0.16.0 → 0.17.0

package/README.md

@@ -188,6 +188,9 @@ Or you can edit the local JSON file directly:
 ### Documents
 
 - **documents-create** - Create a new document in Shortcut with HTML content
+- **documents-list** - List all documents in Shortcut
+- **documents-search** - Search for documents
+- **documents-get-by-id** - Retrieve a specific document in markdown format by its ID
 
 ## Limit tools
 

package/dist/index.js

@@ -1,5 +1,5 @@
 #!/usr/bin/env node
-import { CustomMcpServer, DocumentTools, EpicTools, IterationTools, ObjectiveTools, ShortcutClientWrapper, StoryTools, TeamTools, UserTools, WorkflowTools } from "./workflows-ChA_XcfF.js";
+import { CustomMcpServer, DocumentTools, EpicTools, IterationTools, ObjectiveTools, ShortcutClientWrapper, StoryTools, TeamTools, UserTools, WorkflowTools } from "./workflows-TjriXV16.js";
 import { StdioServerTransport } from "@modelcontextprotocol/sdk/server/stdio.js";
 import { ShortcutClient } from "@shortcut/client";
 

package/dist/server-http.js

@@ -1,4 +1,4 @@
-import { CustomMcpServer, DocumentTools, EpicTools, IterationTools, ObjectiveTools, ShortcutClientWrapper, StoryTools, TeamTools, UserTools, WorkflowTools } from "./workflows-ChA_XcfF.js";
+import { CustomMcpServer, DocumentTools, EpicTools, IterationTools, ObjectiveTools, ShortcutClientWrapper, StoryTools, TeamTools, UserTools, WorkflowTools } from "./workflows-TjriXV16.js";
 import { ShortcutClient } from "@shortcut/client";
 import { randomUUID } from "node:crypto";
 import { StreamableHTTPServerTransport } from "@modelcontextprotocol/sdk/server/streamableHttp.js";

package/dist/{workflows-ChA_XcfF.js → workflows-TjriXV16.js}

@@ -422,6 +422,40 @@ var ShortcutClientWrapper = class {
 		if (!doc) throw new Error(`Failed to create the document: ${response.status}`);
 		return doc;
 	}
+	async listDocs() {
+		const response = await this.client.listDocs();
+		if (response.status === 403) throw new Error("Docs feature disabled for this workspace.");
+		return response?.data ?? null;
+	}
+	async searchDocuments({ title, archived, createdByCurrentUser, followedByCurrentUser, pageSize = 25, nextPageToken }) {
+		const response = await this.client.searchDocuments({
+			title,
+			archived,
+			created_by_me: createdByCurrentUser,
+			followed_by_me: followedByCurrentUser,
+			page_size: pageSize,
+			next: nextPageToken
+		});
+		if (response.status === 403) throw new Error("Docs feature disabled for this workspace.");
+		const documents = response?.data?.data;
+		const total = response?.data?.total;
+		const next = response?.data?.next;
+		if (!documents) return {
+			documents: null,
+			total: null,
+			next_page_token: null
+		};
+		return {
+			documents,
+			total,
+			next_page_token: this.getNextPageToken(next)
+		};
+	}
+	async getDocById(docId) {
+		const response = await this.client.getDoc(docId);
+		if (response.status === 403) throw new Error("Docs feature disabled for this workspace.");
+		return response?.data ?? null;
+	}
 	async uploadFile(storyId, filePath) {
 		const fileContent = readFileSync(filePath);
 		const fileName = basename(filePath);
@@ -447,7 +481,7 @@ var ShortcutClientWrapper = class {
 //#endregion
 //#region package.json
 var name = "@shortcut/mcp";
-var version = "0.16.0";
+var version = "0.17.0";
 
 //#endregion
 //#region src/mcp/CustomMcpServer.ts
@@ -827,6 +861,20 @@ var DocumentTools = class DocumentTools extends BaseTools {
 			title: z.string().max(256).describe("The title for the new document (max 256 characters)"),
 			content: z.string().describe("The content for the new document in HTML format (e.g., <p>Hello</p>, <h1>Title</h1>, <ul><li>Item</li></ul>)")
 		}, async ({ title, content }) => await tools.createDocument(title, content));
+		server.addToolWithReadAccess("documents-list", "List all documents in Shortcut.", async () => await tools.listDocuments());
+		server.addToolWithReadAccess("documents-search", "Find documents.", {
+			nextPageToken: z.string().optional().describe("If a next_page_token was returned from the search result, pass it in to get the next page of results. Should be combined with the original search parameters."),
+			title: z.string().describe("Find documents matching the specified name"),
+			archived: z.boolean().optional().describe("Find only documents matching the specified archived status"),
+			createdByCurrentUser: z.boolean().optional().describe("Find only documents created by current user"),
+			followedByCurrentUser: z.boolean().optional().describe("Find only documents followed by current user")
+		}, async ({ nextPageToken, title, archived, createdByCurrentUser, followedByCurrentUser }) => await tools.searchDocuments({
+			title,
+			archived,
+			createdByCurrentUser,
+			followedByCurrentUser
+		}, nextPageToken));
+		server.addToolWithReadAccess("documents-get-by-id", "Get a document as markdown by its ID", { docId: z.string().describe("The ID of the document to retrieve") }, async ({ docId }) => await tools.getDocumentById(docId));
 		return tools;
 	}
 	async createDocument(title, content) {
@@ -845,6 +893,40 @@ var DocumentTools = class DocumentTools extends BaseTools {
 			return this.toResult(`Failed to create document: ${errorMessage}`);
 		}
 	}
+	async listDocuments() {
+		try {
+			const docs = await this.client.listDocs();
+			if (!docs?.length) return this.toResult("No documents were found.");
+			return this.toResult(`Found ${docs.length} documents.`, docs);
+		} catch (error) {
+			const errorMessage = error instanceof Error ? error.message : "Unknown error";
+			return this.toResult(`Failed to list documents: ${errorMessage}`);
+		}
+	}
+	async searchDocuments(params, nextPageToken) {
+		try {
+			const { documents, total, next_page_token } = await this.client.searchDocuments({
+				...params,
+				nextPageToken
+			});
+			if (!documents) throw new Error(`Failed to search for document matching your query.`);
+			if (!documents.length) return this.toResult(`Result: No documents found.`);
+			return this.toResult(`Result (${documents.length} shown of ${total} total documents found):`, documents, next_page_token);
+		} catch (error) {
+			const errorMessage = error instanceof Error ? error.message : "Unknown error";
+			return this.toResult(`Failed to search documents: ${errorMessage}`);
+		}
+	}
+	async getDocumentById(docId) {
+		try {
+			const doc = await this.client.getDocById(docId);
+			if (!doc) return this.toResult(`Document with ID ${docId} not found.`);
+			return this.toResult(`Document with ID ${docId}`, doc);
+		} catch (error) {
+			const errorMessage = error instanceof Error ? error.message : "Unknown error";
+			return this.toResult(`Failed to get document: ${errorMessage}`);
+		}
+	}
 };
 
 //#endregion

package/package.json

@@ -12,7 +12,7 @@
 		"modelcontextprotocol"
 	],
 	"license": "MIT",
-	"version": "0.16.0",
+	"version": "0.17.0",
 	"type": "module",
 	"main": "dist/index.js",
 	"bin": {
@@ -35,7 +35,7 @@
 	},
 	"dependencies": {
 		"@modelcontextprotocol/sdk": "^1.25.1",
-		"@shortcut/client": "^2.2.0",
+		"@shortcut/client": "^3.1.0",
 		"express": "^4.18.2",
 		"pino": "^9.5.0",
 		"pino-http": "^10.3.0",