@cloudinary/asset-management-mcp 0.6.2 → 0.7.0

package/src/mcp-server/tools.ts

@@ -3,109 +3,83 @@
  */
 
 import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
+import {
+  ShapeOutput,
+  ZodRawShapeCompat,
+} from "@modelcontextprotocol/sdk/server/zod-compat.js";
 import { RequestHandlerExtra } from "@modelcontextprotocol/sdk/shared/protocol.js";
 import {
   CallToolResult,
   ServerNotification,
   ServerRequest,
 } from "@modelcontextprotocol/sdk/types.js";
-import { objectOutputType, ZodRawShape, ZodTypeAny } from "zod";
+import * as z from "zod";
 import { CloudinaryAssetMgmtCore } from "../core.js";
 import { ConsoleLogger } from "./console-logger.js";
-import { MCPScope } from "./scopes.js";
-import { isAsyncIterable, isBinaryData, valueToBase64 } from "./shared.js";
-
-export type ToolDefinition<Args extends undefined | ZodRawShape = undefined> =
-  Args extends ZodRawShape ? {
-      name: string;
-      description: string;
-      scopes?: MCPScope[];
-      args: Args;
-      annotations: {
-        title: string;
-        destructiveHint: boolean;
-        idempotentHint: boolean;
-        openWorldHint: boolean;
-        readOnlyHint: boolean;
-      };
-      tool: (
-        client: CloudinaryAssetMgmtCore,
-        args: objectOutputType<Args, ZodTypeAny>,
-        extra: RequestHandlerExtra<ServerRequest, ServerNotification>,
-      ) => CallToolResult | Promise<CallToolResult>;
-    }
-    : {
-      name: string;
-      description: string;
-      scopes?: MCPScope[];
-      args?: undefined;
-      annotations: {
-        title: string;
-        destructiveHint: boolean;
-        idempotentHint: boolean;
-        openWorldHint: boolean;
-        readOnlyHint: boolean;
-      };
-      tool: (
-        client: CloudinaryAssetMgmtCore,
-        extra: RequestHandlerExtra<ServerRequest, ServerNotification>,
-      ) => CallToolResult | Promise<CallToolResult>;
+import { MCPScope, mcpScopes } from "./scopes.js";
+import { valueToBase64 } from "./shared.js";
+
+export type ToolDefinition<
+  Args extends undefined | ZodRawShapeCompat = undefined,
+> = Args extends ZodRawShapeCompat ? {
+    name: string;
+    description: string;
+    scopes?: MCPScope[];
+    args: Args;
+    annotations: {
+      title: string;
+      destructiveHint: boolean;
+      idempotentHint: boolean;
+      openWorldHint: boolean;
+      readOnlyHint: boolean;
+    };
+    tool: (
+      client: CloudinaryAssetMgmtCore,
+      args: ShapeOutput<Args>,
+      extra: RequestHandlerExtra<ServerRequest, ServerNotification>,
+    ) => CallToolResult | Promise<CallToolResult>;
+  }
+  : {
+    name: string;
+    description: string;
+    scopes?: MCPScope[];
+    args?: undefined;
+    annotations: {
+      title: string;
+      destructiveHint: boolean;
+      idempotentHint: boolean;
+      openWorldHint: boolean;
+      readOnlyHint: boolean;
     };
+    tool: (
+      client: CloudinaryAssetMgmtCore,
+      extra: RequestHandlerExtra<ServerRequest, ServerNotification>,
+    ) => CallToolResult | Promise<CallToolResult>;
+  };
 
 // Optional function to assist with formatting tool results
 export async function formatResult(
-  value: unknown,
-  init: { response?: Response | undefined },
+  response: Response,
 ): Promise<CallToolResult> {
-  if (typeof value === "undefined") {
-    return { content: [] };
-  }
-
-  const { response } = init;
-  const contentType = response?.headers.get("content-type") ?? "";
   let content: CallToolResult["content"] = [];
+  const contentType = response?.headers.get("content-type") ?? "";
 
-  if (contentType.search(/\bjson\b/g)) {
-    content = [{ type: "text", text: JSON.stringify(value) }];
-  } else if (
-    contentType.startsWith("text/event-stream")
-    && isAsyncIterable(value)
-  ) {
-    content = await consumeSSE(value);
-  } else if (contentType.startsWith("text/") && typeof value === "string") {
-    content = [{ type: "text", text: value }];
-  } else if (isBinaryData(value) && contentType.startsWith("image/")) {
-    const data = await valueToBase64(value);
+  if (contentType.startsWith("image/")) {
+    const data = await valueToBase64(await response.arrayBuffer());
     content = data == null
       ? []
       : [{ type: "image", data, mimeType: contentType }];
+  } else if (contentType.startsWith("audio/")) {
+    const data = await valueToBase64(await response.arrayBuffer());
+    content = data == null
+      ? []
+      : [{ type: "audio", data, mimeType: contentType }];
   } else {
-    return {
-      content: [{
-        type: "text",
-        text: `Unsupported content type: "${contentType}"`,
-      }],
-      isError: true,
-    };
+    const text = await response.text();
+    content = [{ type: "text", text }];
   }
 
-  return { content };
-}
-
-async function consumeSSE(
-  value: AsyncIterable<unknown>,
-): Promise<CallToolResult["content"]> {
-  const content: CallToolResult["content"] = [];
-
-  for await (const chunk of value) {
-    if (typeof chunk === "string") {
-      content.push({ type: "text", text: chunk });
-    } else {
-      content.push({ type: "text", text: JSON.stringify(chunk) });
-    }
-  }
-
-  return content;
+  return response.ok ? { content } : { content, isError: true };
 }
 
 export function createRegisterTool(
@@ -114,8 +88,20 @@ export function createRegisterTool(
   getSDK: () => CloudinaryAssetMgmtCore,
   allowedScopes: Set<MCPScope>,
   allowedTools?: Set<string>,
-): <A extends ZodRawShape | undefined>(tool: ToolDefinition<A>) => void {
-  return <A extends ZodRawShape | undefined>(tool: ToolDefinition<A>): void => {
+  dynamic?: boolean,
+): [
+  <A extends ZodRawShapeCompat | undefined>(tool: ToolDefinition<A>) => void,
+  Array<{ name: string; description: string }>,
+  Map<string, ToolDefinition<ZodRawShapeCompat | undefined>>,
+] {
+  const tools: Array<{ name: string; description: string }> = [];
+  const toolMap = new Map<
+    string,
+    ToolDefinition<ZodRawShapeCompat | undefined>
+  >();
+  const registerTool = <A extends ZodRawShapeCompat | undefined>(
+    tool: ToolDefinition<A>,
+  ): void => {
     if (allowedTools && !allowedTools.has(tool.name)) {
       return;
     }
@@ -132,27 +118,261 @@ export function createRegisterTool(
       return;
     }
 
+    toolMap.set(
+      tool.name,
+      tool as ToolDefinition<ZodRawShapeCompat | undefined>,
+    );
+
+    if (dynamic) {
+      logger.debug("Collected tool for dynamic mode", { name: tool.name });
+      tools.push({ name: tool.name, description: tool.description });
+      return;
+    }
+
     if (tool.args) {
-      server.tool(
+      server.registerTool(
         tool.name,
-        tool.description,
-        tool.args,
-        tool.annotations,
+        {
+          description: tool.description,
+          inputSchema: tool.args,
+          annotations: tool.annotations,
+        },
         async (args, ctx) => {
           return tool.tool(getSDK(), args, ctx);
         },
       );
     } else {
-      server.tool(
+      server.registerTool(
         tool.name,
-        tool.description,
-        tool.annotations,
-        async (_, ctx) => {
+        {
+          description: tool.description,
+          annotations: tool.annotations,
+        },
+        async (ctx) => {
           return tool.tool(getSDK(), ctx);
         },
       );
     }
 
     logger.debug("Registered tool", { name: tool.name });
+    tools.push({ name: tool.name, description: tool.description });
   };
+
+  return [registerTool, tools, toolMap];
+}
+
+function matchesSearchTerms(
+  terms: string[],
+  name: string,
+  def: ToolDefinition<ZodRawShapeCompat | undefined>,
+): boolean {
+  if (terms.length === 0) {
+    return true;
+  }
+
+  const nameLower = name.toLowerCase();
+  const descLower = def.description.toLowerCase();
+  const scopesLower = def.scopes?.flatMap((s: unknown) => {
+    return typeof s === "string" ? [s.toLowerCase()] : [];
+  }) || [];
+
+  return terms.some((term) =>
+    nameLower.includes(term)
+    || descLower.includes(term)
+    || scopesLower.some((s) => s.includes(term))
+  );
+}
+
+export function registerDynamicTools(
+  logger: ConsoleLogger,
+  server: McpServer,
+  getSDK: () => CloudinaryAssetMgmtCore,
+  toolMap: Map<string, ToolDefinition<ZodRawShapeCompat | undefined>>,
+  allowedScopes: Set<MCPScope>,
+): void {
+  // 1. list_tools
+  server.registerTool("list_tools", {
+    description:
+      "List available tools. Optionally filter by search terms that match against tool name, description, and scopes.",
+    inputSchema: {
+      search_terms: z.array(z.string()).optional().describe(
+        [
+          "Filter the list of tools.",
+          "Each term is matched case-insensitively as a substring against tool name, description, and scopes.",
+          "Multiple terms are combined with a logical OR: a tool is included if ANY term matches ANY field.",
+          "If not provided, all tools are returned.",
+        ].join("\n"),
+      ),
+    },
+    annotations: {
+      title: "List Tools",
+      readOnlyHint: true,
+      destructiveHint: false,
+      idempotentHint: true,
+      openWorldHint: false,
+    },
+  }, async (args) => {
+    const terms = (args.search_terms ?? []).map((t) => t.toLowerCase());
+
+    const tools: Array<
+      { name: string; description: string; scopes?: MCPScope[] | undefined }
+    > = [];
+    for (const [name, def] of toolMap) {
+      if (!matchesSearchTerms(terms, name, def)) {
+        continue;
+      }
+
+      tools.push({
+        name: name,
+        description: def.description,
+        scopes: def.scopes,
+      });
+    }
+    return {
+      content: [{ type: "text", text: JSON.stringify(tools, null, 2) }],
+    };
+  });
+  logger.debug("Registered dynamic meta-tool", { name: "list_tools" });
+
+  // 2. describe_tool
+  server.registerTool("describe_tool_input", {
+    description:
+      "Get the input schema for one or more tools. It is a good idea to call this tool first to understand how to successfully call execute_tool.",
+    inputSchema: {
+      tool_names: z.array(z.string()).describe(
+        "The names of the tools to describe",
+      ),
+    },
+    annotations: {
+      title: "Describe Tool",
+      readOnlyHint: true,
+      destructiveHint: false,
+      idempotentHint: true,
+      openWorldHint: false,
+    },
+  }, async (args) => {
+    const parts: string[] = [];
+    const unknown: string[] = [];
+
+    if (args.tool_names.length === 0) {
+      return { content: [{ type: "text", text: "No tool names provided." }] };
+    }
+
+    for (const toolName of args.tool_names) {
+      const def = toolMap.get(toolName);
+      if (!def) {
+        unknown.push(toolName);
+        continue;
+      }
+
+      let schemaText = `<input_schema tool="${toolName}">\n\n`;
+      if (def.args) {
+        const jsonSchema = z.toJSONSchema(z.object(def.args), {
+          target: "draft-2020-12",
+        });
+        schemaText += JSON.stringify(jsonSchema, null, 2);
+      } else {
+        schemaText += "This tool takes no input parameters.";
+      }
+      schemaText += `\n\n</input_schema>`;
+      parts.push(schemaText);
+    }
+
+    if (unknown.length > 0) {
+      parts.push(`Unknown tools: ${unknown.join(", ")}`);
+    }
+
+    return { content: [{ type: "text", text: parts.join("\n\n") }] };
+  });
+  logger.debug("Registered dynamic meta-tool", { name: "describe_tool" });
+
+  // 3. execute_tool
+  server.registerTool("execute_tool", {
+    description:
+      "Execute a tool by name with the provided input parameters. If executing a given tool for the first time, it is recommended to call describe_tool_input first to understand the expected input schema.",
+    inputSchema: {
+      tool_name: z.string().describe("The name of the tool to execute"),
+      input: z.record(z.string(), z.unknown()).optional().describe(
+        "Input parameters for the tool as a JSON object",
+      ),
+    },
+    annotations: {
+      title: "Execute Tool",
+      readOnlyHint: false,
+      destructiveHint: true,
+      idempotentHint: false,
+      openWorldHint: true,
+    },
+  }, async (args, ctx) => {
+    const def = toolMap.get(args.tool_name);
+    if (!def) {
+      return {
+        content: [{ type: "text", text: `Unknown tool: ${args.tool_name}` }],
+        isError: true,
+      };
+    }
+
+    let validatedInput: Record<string, unknown> = {};
+    if (def.args) {
+      const vres = z.object(def.args).safeParse(args.input ?? {});
+      if (vres.success) {
+        validatedInput = vres.data;
+      } else {
+        const issues = z.prettifyError(vres.error);
+
+        return {
+          content: [{
+            type: "text",
+            text:
+              `Invalid input for tool ${args.tool_name}:\n<issues>\n${issues}\n</issues>`,
+          }],
+          isError: true,
+        };
+      }
+    }
+
+    try {
+      if (def.args) {
+        return await def.tool(getSDK(), validatedInput, ctx);
+      } else {
+        return await def.tool(getSDK(), ctx);
+      }
+    } catch (error) {
+      const message = error instanceof Error ? error.message : String(error);
+      return {
+        content: [{
+          type: "text",
+          text: `Error executing tool ${args.tool_name}: ${message}`,
+        }],
+        isError: true,
+      };
+    }
+  });
+  logger.debug("Registered dynamic meta-tool", { name: "execute_tool" });
+
+  // 4. list_scopes (only when the server has scopes defined)
+  if (mcpScopes.length > 0) {
+    const scopes = allowedScopes.size > 0
+      ? [...allowedScopes].sort()
+      : [...mcpScopes];
+
+    server.registerTool("list_scopes", {
+      description: [
+        "List the scopes available on this server.",
+        "Scopes are categories that group related tools together.",
+        "They can be used as search terms when filtering the list of tools.",
+      ].join("\n"),
+      annotations: {
+        title: "List Scopes",
+        readOnlyHint: true,
+        destructiveHint: false,
+        idempotentHint: true,
+        openWorldHint: false,
+      },
+    }, async () => {
+      const lines = scopes.map((s) => `- ${s}`);
+      return { content: [{ type: "text", text: lines.join("\n") }] };
+    });
+    logger.debug("Registered dynamic meta-tool", { name: "list_scopes" });
+  }
 }

package/src/models/accesscontrolitem.ts

@@ -3,17 +3,25 @@
  */
 
 import * as z from "zod";
+import { ClosedEnum } from "../types/enums.js";
 
 /**
  * The type of access control to apply to the asset.
  */
+export const AccessType = {
+  Token: "token",
+  Anonymous: "anonymous",
+} as const;
+/**
+ * The type of access control to apply to the asset.
+ */
+export type AccessType = ClosedEnum<typeof AccessType>;
+
 export const AccessType$zodSchema = z.enum([
   "token",
   "anonymous",
 ]).describe("The type of access control to apply to the asset.");
 
-export type AccessType = z.infer<typeof AccessType$zodSchema>;
-
 /**
  * Access control rule that defines when and how the asset can be accessed.
  */
@@ -24,15 +32,12 @@ export type AccessControlItem = {
   end?: string | undefined;
 };
 
-export const AccessControlItem$zodSchema: z.ZodType<
-  AccessControlItem,
-  z.ZodTypeDef,
-  unknown
-> = z.object({
-  access_type: AccessType$zodSchema,
-  end: z.string().optional(),
-  key: z.string().optional(),
-  start: z.string().optional(),
-}).describe(
-  "Access control rule that defines when and how the asset can be accessed.",
-);
+export const AccessControlItem$zodSchema: z.ZodType<AccessControlItem> = z
+  .object({
+    access_type: AccessType$zodSchema,
+    end: z.string().optional(),
+    key: z.string().optional(),
+    start: z.string().optional(),
+  }).describe(
+    "Access control rule that defines when and how the asset can be accessed.",
+  );

package/src/models/apierror.ts

@@ -6,17 +6,12 @@ import * as z from "zod";
 
 export type ApiErrorError = { message: string };
 
-export const ApiErrorError$zodSchema: z.ZodType<
-  ApiErrorError,
-  z.ZodTypeDef,
-  unknown
-> = z.object({
+export const ApiErrorError$zodSchema: z.ZodType<ApiErrorError> = z.object({
   message: z.string(),
 });
 
 export type ApiError = { error: ApiErrorError };
 
-export const ApiError$zodSchema: z.ZodType<ApiError, z.ZodTypeDef, unknown> = z
-  .object({
-    error: z.lazy(() => ApiErrorError$zodSchema),
-  });
+export const ApiError$zodSchema: z.ZodType<ApiError> = z.object({
+  error: z.lazy(() => ApiErrorError$zodSchema),
+});

package/src/models/archiveresourcetype.ts

@@ -3,10 +3,22 @@
  */
 
 import * as z from "zod";
+import { ClosedEnum } from "../types/enums.js";
 
 /**
  * The type of resources to include in the archive. "image" for images, "video" for videos, "raw" for non-media files, or "all" for mixed types.
  */
+export const ArchiveResourceType = {
+  Image: "image",
+  Video: "video",
+  Raw: "raw",
+  All: "all",
+} as const;
+/**
+ * The type of resources to include in the archive. "image" for images, "video" for videos, "raw" for non-media files, or "all" for mixed types.
+ */
+export type ArchiveResourceType = ClosedEnum<typeof ArchiveResourceType>;
+
 export const ArchiveResourceType$zodSchema = z.enum([
   "image",
   "video",
@@ -15,5 +27,3 @@ export const ArchiveResourceType$zodSchema = z.enum([
 ]).describe(
   "The type of resources to include in the archive. \"image\" for images, \"video\" for videos, \"raw\" for non-media files, or \"all\" for mixed types.",
 );
-
-export type ArchiveResourceType = z.infer<typeof ArchiveResourceType$zodSchema>;

package/src/models/archivestoragetype.ts

@@ -3,15 +3,25 @@
  */
 
 import * as z from "zod";
+import { ClosedEnum } from "../types/enums.js";
 
 /**
  * The storage type of resources to include in the archive.
  */
+export const ArchiveStorageType = {
+  Upload: "upload",
+  Private: "private",
+  Authenticated: "authenticated",
+  Fetch: "fetch",
+} as const;
+/**
+ * The storage type of resources to include in the archive.
+ */
+export type ArchiveStorageType = ClosedEnum<typeof ArchiveStorageType>;
+
 export const ArchiveStorageType$zodSchema = z.enum([
   "upload",
   "private",
   "authenticated",
   "fetch",
 ]).describe("The storage type of resources to include in the archive.");
-
-export type ArchiveStorageType = z.infer<typeof ArchiveStorageType$zodSchema>;

package/src/models/assetrelationinfo.ts

@@ -3,10 +3,26 @@
  */
 
 import * as z from "zod";
+import { ClosedEnum } from "../types/enums.js";
 
 /**
  * The code indicating the result of the operation.
  */
+export const Code = {
+  RejectedIds: "rejected_ids",
+  InvalidIds: "invalid_ids",
+  InternalErrorIds: "internal_error_ids",
+  NonExistingIds: "non_existing_ids",
+  InvalidRelateToSelfId: "invalid_relate_to_self_id",
+  AlreadyExistsIds: "already_exists_ids",
+  RelationDoesNotExistIds: "relation_does_not_exist_ids",
+  SuccessIds: "success_ids",
+} as const;
+/**
+ * The code indicating the result of the operation.
+ */
+export type Code = ClosedEnum<typeof Code>;
+
 export const Code$zodSchema = z.enum([
   "rejected_ids",
   "invalid_ids",
@@ -18,8 +34,6 @@ export const Code$zodSchema = z.enum([
   "success_ids",
 ]).describe("The code indicating the result of the operation.");
 
-export type Code = z.infer<typeof Code$zodSchema>;
-
 export type AssetRelationInfo = {
   message?: string | undefined;
   code?: Code | undefined;
@@ -27,13 +41,10 @@ export type AssetRelationInfo = {
   status?: number | undefined;
 };
 
-export const AssetRelationInfo$zodSchema: z.ZodType<
-  AssetRelationInfo,
-  z.ZodTypeDef,
-  unknown
-> = z.object({
-  asset: z.string().optional(),
-  code: Code$zodSchema.optional(),
-  message: z.string().optional(),
-  status: z.number().int().optional(),
-});
+export const AssetRelationInfo$zodSchema: z.ZodType<AssetRelationInfo> = z
+  .object({
+    asset: z.string().optional(),
+    code: Code$zodSchema.optional(),
+    message: z.string().optional(),
+    status: z.int().optional(),
+  });

package/src/models/assetrelationsdeleteresponse.ts

@@ -14,9 +14,7 @@ export type AssetRelationsDeleteResponse = {
 };
 
 export const AssetRelationsDeleteResponse$zodSchema: z.ZodType<
-  AssetRelationsDeleteResponse,
-  z.ZodTypeDef,
-  unknown
+  AssetRelationsDeleteResponse
 > = z.object({
   failed: z.array(AssetRelationInfo$zodSchema).optional(),
   success: z.array(AssetRelationInfo$zodSchema).optional(),

package/src/models/assetrelationsresponse.ts

@@ -14,9 +14,7 @@ export type AssetRelationsResponse = {
 };
 
 export const AssetRelationsResponse$zodSchema: z.ZodType<
-  AssetRelationsResponse,
-  z.ZodTypeDef,
-  unknown
+  AssetRelationsResponse
 > = z.object({
   failed: z.array(AssetRelationInfo$zodSchema).optional(),
   success: z.array(AssetRelationInfo$zodSchema).optional(),