From 77deef08ce2bbe701c7994fc08b71ca306e44a4f Mon Sep 17 00:00:00 2001 From: cliffhall Date: Sat, 13 Dec 2025 15:24:10 -0500 Subject: [PATCH] Update doc in tools/gzip-file-as-resource.ts --- src/everything/tools/gzip-file-as-resource.ts | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/src/everything/tools/gzip-file-as-resource.ts b/src/everything/tools/gzip-file-as-resource.ts index 4396b6a0..147c9802 100644 --- a/src/everything/tools/gzip-file-as-resource.ts +++ b/src/everything/tools/gzip-file-as-resource.ts @@ -50,6 +50,21 @@ const config = { inputSchema: GZipFileAsResourceSchema, }; +/** + * Registers the `gzip-file-as-resource` tool with the provided MCP server. + * + * The registered tool compresses input data using gzip, and makes the resulting file accessible + * as a resource for the duration of the session. + * + * The tool supports two output types: + * - "resource": Returns the resource directly, including its URI, MIME type, and base64-encoded content. + * - "resourceLink": Returns a link to access the resource later. + * + * If an unrecognized `outputType` is provided, the tool throws an error. + * + * @param {McpServer} server - The server instance where the tool will be registered. + * @throws {Error} Throws an error if an unknown output type is specified. + */ export const registerGZipFileAsResourceTool = (server: McpServer) => { server.registerTool(name, config, async (args): Promise => { const {