@cloudinary/asset-management-mcp 0.6.0

package/src/mcp-server/tools/assetRelationsCreateAssetRelationsByAssetId.ts

@@ -0,0 +1,52 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { assetRelationsCreateAssetRelationsByAssetId } from "../../funcs/assetRelationsCreateAssetRelationsByAssetId.js";
+import { CreateAssetRelationsByAssetIdRequestBody$zodSchema } from "../../models/createassetrelationsbyassetidop.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  asset_id: z.string().describe(
+    "The asset ID of the resource. Must be a 32-character hexadecimal string.",
+  ),
+  RequestBody: CreateAssetRelationsByAssetIdRequestBody$zodSchema,
+};
+
+export const tool$assetRelationsCreateAssetRelationsByAssetId: ToolDefinition<
+  typeof args
+> = {
+  name: "create-asset-relations",
+  description: `Add related assets by asset ID
+
+Relates an asset to other assets by their asset IDs, an immutable identifier, regardless of public ID, display name, asset folder, resource type or deliver type. This is a bidirectional process, meaning that the asset will also be added as a related_asset to all the other assets specified. The relation is also a one to many relationship, where the asset is related to all the assets specified, but those assets aren't also related to each other.`,
+  scopes: ["librarian"],
+  annotations: {
+    "title": "Create Asset Relations",
+    "destructiveHint": false,
+    "idempotentHint": false,
+    "openWorldHint": false,
+    "readOnlyHint": false,
+  },
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await assetRelationsCreateAssetRelationsByAssetId(
+      client,
+      args.asset_id,
+      args.RequestBody,
+      { fetchOptions: { signal: ctx.signal } },
+    ).$inspect();
+
+    if (!result.ok) {
+      return {
+        content: [{ type: "text", text: result.error.message }],
+        isError: true,
+      };
+    }
+
+    const value = result.value;
+
+    return formatResult(value, apiCall);
+  },
+};

package/src/mcp-server/tools/assetRelationsDeleteAssetRelationsByAssetId.ts

@@ -0,0 +1,52 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { assetRelationsDeleteAssetRelationsByAssetId } from "../../funcs/assetRelationsDeleteAssetRelationsByAssetId.js";
+import { DeleteAssetRelationsByAssetIdRequestBody$zodSchema } from "../../models/deleteassetrelationsbyassetidop.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  asset_id: z.string().describe(
+    "The asset ID of the resource. Must be a 32-character hexadecimal string.",
+  ),
+  RequestBody: DeleteAssetRelationsByAssetIdRequestBody$zodSchema,
+};
+
+export const tool$assetRelationsDeleteAssetRelationsByAssetId: ToolDefinition<
+  typeof args
+> = {
+  name: "delete-asset-relations",
+  description: `Delete asset relations by asset ID
+
+Unrelates the asset from other assets, specified by their asset IDs, an immutable identifier, regardless of public ID, display name, asset folder, resource type or deliver type. This is a bidirectional process, meaning that the asset will also be removed as a related_asset from all the other assets specified.`,
+  scopes: ["librarian"],
+  annotations: {
+    "title": "Delete Asset Relations",
+    "destructiveHint": true,
+    "idempotentHint": true,
+    "openWorldHint": false,
+    "readOnlyHint": false,
+  },
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await assetRelationsDeleteAssetRelationsByAssetId(
+      client,
+      args.asset_id,
+      args.RequestBody,
+      { fetchOptions: { signal: ctx.signal } },
+    ).$inspect();
+
+    if (!result.ok) {
+      return {
+        content: [{ type: "text", text: result.error.message }],
+        isError: true,
+      };
+    }
+
+    const value = result.value;
+
+    return formatResult(value, apiCall);
+  },
+};

package/src/mcp-server/tools/assetsDerivedDestroy.ts

@@ -0,0 +1,45 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { assetsDerivedDestroy } from "../../funcs/assetsDerivedDestroy.js";
+import { DerivedDestroyRequest$zodSchema } from "../../models/deriveddestroyrequest.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  request: DerivedDestroyRequest$zodSchema,
+};
+
+export const tool$assetsDerivedDestroy: ToolDefinition<typeof args> = {
+  name: "delete-derived-assets",
+  description: `Delete derived resources
+
+Deletes derived resources by derived resource ID`,
+  scopes: ["librarian"],
+  annotations: {
+    "title": "Delete Derived Assets",
+    "destructiveHint": true,
+    "idempotentHint": true,
+    "openWorldHint": false,
+    "readOnlyHint": false,
+  },
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await assetsDerivedDestroy(
+      client,
+      args.request,
+      { fetchOptions: { signal: ctx.signal } },
+    ).$inspect();
+
+    if (!result.ok) {
+      return {
+        content: [{ type: "text", text: result.error.message }],
+        isError: true,
+      };
+    }
+
+    const value = result.value;
+
+    return formatResult(value, apiCall);
+  },
+};

package/src/mcp-server/tools/assetsDestroyByAssetId.ts

@@ -0,0 +1,47 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { assetsDestroyByAssetId } from "../../funcs/assetsDestroyByAssetId.js";
+import { DestroyRequest$zodSchema } from "../../models/destroyrequest.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  request: DestroyRequest$zodSchema,
+};
+
+export const tool$assetsDestroyByAssetId: ToolDefinition<typeof args> = {
+  name: "delete-asset",
+  description: `Delete asset by asset-id
+
+Deletes an asset using its asset ID. This endpoint replaces the legacy /resources/by_asset_id endpoint.
+Returns the deletion status and asset folder information when folder decoupling is enabled.
+`,
+  scopes: ["admin"],
+  annotations: {
+    "title": "Delete Asset",
+    "destructiveHint": true,
+    "idempotentHint": true,
+    "openWorldHint": false,
+    "readOnlyHint": false,
+  },
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await assetsDestroyByAssetId(
+      client,
+      args.request,
+      { fetchOptions: { signal: ctx.signal } },
+    ).$inspect();
+
+    if (!result.ok) {
+      return {
+        content: [{ type: "text", text: result.error.message }],
+        isError: true,
+      };
+    }
+
+    const value = result.value;
+
+    return formatResult(value, apiCall);
+  },
+};

package/src/mcp-server/tools/assetsDownloadBackupAsset.ts

@@ -0,0 +1,61 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { assetsDownloadBackupAsset } from "../../funcs/assetsDownloadBackupAsset.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  asset_id: z.string().describe(
+    "The asset ID of the resource. Must be a 32-character hexadecimal string.",
+  ),
+  version_id: z.string().describe(
+    "The version ID of the backup to download. Must be a 32-character hexadecimal string.",
+  ),
+  api_key: z.string().describe(
+    "The API key to use for the request. This is automatically computed by the Cloudinary's SDKs.",
+  ).optional(),
+  signature: z.string().describe(
+    "(Required for signed REST API calls) Used to authenticate the request and based on the parameters you use in the request. When using the Cloudinary SDKs for signed requests, the signature is automatically generated and added to the request. If you manually generate your own signed POST request, you need to manually generate the signature parameter and add it to the request together with the api_key and timestamp parameters.\n"
+      + "",
+  ).optional(),
+  timestamp: z.number().int().describe(
+    "The timestamp to use for the request in unix time. This is automatically computed by the Cloudinary's SDKs.",
+  ).optional(),
+};
+
+export const tool$assetsDownloadBackupAsset: ToolDefinition<typeof args> = {
+  name: "download-asset-backup",
+  description: `Download a backup copy of an asset`,
+  annotations: {
+    "title": "Download Asset Backup",
+    "destructiveHint": false,
+    "idempotentHint": false,
+    "openWorldHint": false,
+    "readOnlyHint": true,
+  },
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await assetsDownloadBackupAsset(
+      client,
+      args.asset_id,
+      args.version_id,
+      args.api_key,
+      args.signature,
+      args.timestamp,
+      { fetchOptions: { signal: ctx.signal } },
+    ).$inspect();
+
+    if (!result.ok) {
+      return {
+        content: [{ type: "text", text: result.error.message }],
+        isError: true,
+      };
+    }
+
+    const value = result.value;
+
+    return formatResult(value, apiCall);
+  },
+};

package/src/mcp-server/tools/assetsGenerateArchive.ts

@@ -0,0 +1,49 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { assetsGenerateArchive } from "../../funcs/assetsGenerateArchive.js";
+import { ArchiveResourceType$zodSchema } from "../../models/archiveresourcetype.js";
+import { GenerateArchiveRequestBody$zodSchema } from "../../models/generatearchiveop.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  resource_type: ArchiveResourceType$zodSchema,
+  RequestBody: GenerateArchiveRequestBody$zodSchema,
+};
+
+export const tool$assetsGenerateArchive: ToolDefinition<typeof args> = {
+  name: "generate-archive",
+  description:
+    `Creates an archive (ZIP or TGZ file) that contains a set of assets from your product environment.
+
+Creates a downloadable ZIP or other archive format containing the specified resources.`,
+  scopes: ["librarian"],
+  annotations: {
+    "title": "Generate Archive",
+    "destructiveHint": false,
+    "idempotentHint": false,
+    "openWorldHint": false,
+    "readOnlyHint": false,
+  },
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await assetsGenerateArchive(
+      client,
+      args.resource_type,
+      args.RequestBody,
+      { fetchOptions: { signal: ctx.signal } },
+    ).$inspect();
+
+    if (!result.ok) {
+      return {
+        content: [{ type: "text", text: result.error.message }],
+        isError: true,
+      };
+    }
+
+    const value = result.value;
+
+    return formatResult(value, apiCall);
+  },
+};

package/src/mcp-server/tools/assetsGetResourceByAssetId.ts

@@ -0,0 +1,91 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { assetsGetResourceByAssetId } from "../../funcs/assetsGetResourceByAssetId.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  asset_id: z.string().describe(
+    "The asset ID of the resource. Must be a 32-character hexadecimal string.",
+  ),
+  colors: z.boolean().default(false).describe(
+    "Whether to include color information (predominant colors and histogram of 32 leading colors). Default: false.",
+  ),
+  media_metadata: z.boolean().default(false).describe(
+    "Whether to include IPTC, XMP, and detailed Exif metadata in the response. Default: false.",
+  ),
+  faces: z.boolean().default(false).describe(
+    "Whether to include a list of coordinates of detected faces. Default: false.",
+  ),
+  quality_analysis: z.boolean().default(false).describe(
+    "Whether to return quality analysis scores for the image. Default: false.",
+  ),
+  accessibility_analysis: z.boolean().default(false).describe(
+    "Whether to return accessibility analysis scores for the image. Default: false.",
+  ),
+  pages: z.boolean().default(false).describe(
+    "Whether to report the number of pages in multi-page documents (e.g., PDF). Default: false.",
+  ),
+  phash: z.boolean().default(false).describe(
+    "Whether to include the perceptual hash (pHash) of the uploaded photo for image similarity detection. Default: false.",
+  ),
+  coordinates: z.boolean().default(false).describe(
+    "Whether to include previously specified custom cropping coordinates and faces coordinates. Default: false.",
+  ),
+  versions: z.boolean().default(false).describe(
+    "Whether to include details of all the backed up versions of the asset. Default: false.",
+  ),
+  max_results: z.number().int().default(10).describe(
+    "Maximum number of derived assets to return. Default: 10.",
+  ),
+  derived_next_cursor: z.string().describe(
+    "The cursor for the next page of derived assets when there are more derived images than max_results.",
+  ).optional(),
+};
+
+export const tool$assetsGetResourceByAssetId: ToolDefinition<typeof args> = {
+  name: "get-asset-details",
+  description: `Get resource by asset ID
+
+Returns the details of a single resource specified by its asset ID.`,
+  scopes: ["librarian"],
+  annotations: {
+    "title": "Get Asset Details",
+    "destructiveHint": false,
+    "idempotentHint": true,
+    "openWorldHint": false,
+    "readOnlyHint": true,
+  },
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await assetsGetResourceByAssetId(
+      client,
+      args.asset_id,
+      args.colors,
+      args.media_metadata,
+      args.faces,
+      args.quality_analysis,
+      args.accessibility_analysis,
+      args.pages,
+      args.phash,
+      args.coordinates,
+      args.versions,
+      args.max_results,
+      args.derived_next_cursor,
+      { fetchOptions: { signal: ctx.signal } },
+    ).$inspect();
+
+    if (!result.ok) {
+      return {
+        content: [{ type: "text", text: result.error.message }],
+        isError: true,
+      };
+    }
+
+    const value = result.value;
+
+    return formatResult(value, apiCall);
+  },
+};

package/src/mcp-server/tools/assetsListImages.ts

@@ -0,0 +1,74 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { assetsListImages } from "../../funcs/assetsListImages.js";
+import { Direction$zodSchema } from "../../models/direction.js";
+import { FieldsSpec$zodSchema } from "../../models/fieldsspec.js";
+import { ListStorageType$zodSchema } from "../../models/liststoragetype.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  type: ListStorageType$zodSchema.optional(),
+  prefix: z.string().describe(
+    "Find resources with a public ID prefix. Requires the `type` parameter.",
+  ).optional(),
+  public_ids: z.array(z.string()).describe("An array of public IDs to return.")
+    .optional(),
+  tags: z.boolean().describe(
+    "Whether to include the list of tag names assigned to each asset. Default: false",
+  ).optional(),
+  next_cursor: z.string().describe("Cursor for pagination.").optional(),
+  max_results: z.number().int().describe(
+    "Maximum number of results to return (1-500).",
+  ).optional(),
+  direction: Direction$zodSchema.optional(),
+  start_at: z.string().datetime({ offset: true }).describe(
+    "Retrieve resources uploaded after this timestamp.",
+  ).optional(),
+  fields: z.array(FieldsSpec$zodSchema).optional(),
+};
+
+export const tool$assetsListImages: ToolDefinition<typeof args> = {
+  name: "list-images",
+  description: `Get image assets
+
+Retrieves a list of image assets. Results can be filtered by various criteria like tags, moderation status, prefix, or specific public IDs.
+`,
+  scopes: ["librarian"],
+  annotations: {
+    "title": "List Images",
+    "destructiveHint": false,
+    "idempotentHint": true,
+    "openWorldHint": false,
+    "readOnlyHint": true,
+  },
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await assetsListImages(
+      client,
+      args.type,
+      args.prefix,
+      args.public_ids,
+      args.tags,
+      args.next_cursor,
+      args.max_results,
+      args.direction,
+      args.start_at,
+      args.fields,
+      { fetchOptions: { signal: ctx.signal } },
+    ).$inspect();
+
+    if (!result.ok) {
+      return {
+        content: [{ type: "text", text: result.error.message }],
+        isError: true,
+      };
+    }
+
+    const value = result.value;
+
+    return formatResult(value, apiCall);
+  },
+};

package/src/mcp-server/tools/assetsListRawFiles.ts

@@ -0,0 +1,74 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { assetsListRawFiles } from "../../funcs/assetsListRawFiles.js";
+import { Direction$zodSchema } from "../../models/direction.js";
+import { FieldsSpec$zodSchema } from "../../models/fieldsspec.js";
+import { ListStorageType$zodSchema } from "../../models/liststoragetype.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  type: ListStorageType$zodSchema.optional(),
+  prefix: z.string().describe(
+    "A public_id prefix. When specified, all assets with that prefix are returned. When using this, the `type` parameter must also be specified.",
+  ).optional(),
+  public_ids: z.array(z.string()).describe("An array of public IDs to return.")
+    .optional(),
+  tags: z.boolean().describe(
+    "Whether to include the list of tag names assigned to each asset. Default: false",
+  ).optional(),
+  next_cursor: z.string().describe("Cursor for pagination.").optional(),
+  max_results: z.number().int().describe(
+    "Maximum number of results to return (1-500).",
+  ).optional(),
+  direction: Direction$zodSchema.optional(),
+  start_at: z.string().datetime({ offset: true }).describe(
+    "An ISO-8601 formatted timestamp. When specified, assets created since that timestamp are returned.  Supported only if neither `prefix` nor `public_ids` were passed.",
+  ).optional(),
+  fields: z.array(FieldsSpec$zodSchema).optional(),
+};
+
+export const tool$assetsListRawFiles: ToolDefinition<typeof args> = {
+  name: "list-files",
+  description: `Get raw assets
+
+Retrieves a list of raw assets. Results can be filtered by various criteria like tags, moderation status, prefix, or specific public IDs.
+`,
+  scopes: ["librarian"],
+  annotations: {
+    "title": "List Files",
+    "destructiveHint": false,
+    "idempotentHint": true,
+    "openWorldHint": false,
+    "readOnlyHint": true,
+  },
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await assetsListRawFiles(
+      client,
+      args.type,
+      args.prefix,
+      args.public_ids,
+      args.tags,
+      args.next_cursor,
+      args.max_results,
+      args.direction,
+      args.start_at,
+      args.fields,
+      { fetchOptions: { signal: ctx.signal } },
+    ).$inspect();
+
+    if (!result.ok) {
+      return {
+        content: [{ type: "text", text: result.error.message }],
+        isError: true,
+      };
+    }
+
+    const value = result.value;
+
+    return formatResult(value, apiCall);
+  },
+};

package/src/mcp-server/tools/assetsListResourceTags.ts

@@ -0,0 +1,60 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { assetsListResourceTags } from "../../funcs/assetsListResourceTags.js";
+import { ResourceType$zodSchema } from "../../models/resourcetype.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  resource_type: ResourceType$zodSchema,
+  prefix: z.string().describe(
+    "The prefix to use if you want to limit the returned tags to those that start with the specified prefix.",
+  ).optional(),
+  next_cursor: z.string().describe("Cursor for pagination.").optional(),
+  max_results: z.number().int().describe(
+    "Maximum number of results to return (1-500).",
+  ).optional(),
+};
+
+export const tool$assetsListResourceTags: ToolDefinition<typeof args> = {
+  name: "list-tags",
+  description:
+    `Retrieves a list of tags currently applied to assets in your Cloudinary account
+
+Retrieves a comprehensive list of all tags that exist in your product environment for assets of the specified type.
+
+[Cloudinary Admin API documentation](https://cloudinary.com/documentation/admin_api)
+`,
+  scopes: ["librarian"],
+  annotations: {
+    "title": "List Tags",
+    "destructiveHint": false,
+    "idempotentHint": true,
+    "openWorldHint": false,
+    "readOnlyHint": true,
+  },
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await assetsListResourceTags(
+      client,
+      args.resource_type,
+      args.prefix,
+      args.next_cursor,
+      args.max_results,
+      { fetchOptions: { signal: ctx.signal } },
+    ).$inspect();
+
+    if (!result.ok) {
+      return {
+        content: [{ type: "text", text: result.error.message }],
+        isError: true,
+      };
+    }
+
+    const value = result.value;
+
+    return formatResult(value, apiCall);
+  },
+};

package/src/mcp-server/tools/assetsListVideos.ts

@@ -0,0 +1,74 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { assetsListVideos } from "../../funcs/assetsListVideos.js";
+import { Direction$zodSchema } from "../../models/direction.js";
+import { FieldsSpec$zodSchema } from "../../models/fieldsspec.js";
+import { ListStorageType$zodSchema } from "../../models/liststoragetype.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  type: ListStorageType$zodSchema.optional(),
+  prefix: z.string().describe(
+    "A public_id prefix. When specified, all assets with that prefix are returned. When using this, the `type` parameter must also be specified.",
+  ).optional(),
+  public_ids: z.array(z.string()).describe("An array of public IDs to return.")
+    .optional(),
+  tags: z.boolean().describe(
+    "Whether to include the list of tag names assigned to each asset. Default: false",
+  ).optional(),
+  next_cursor: z.string().describe("Cursor for pagination.").optional(),
+  max_results: z.number().int().describe(
+    "Maximum number of results to return (1-500).",
+  ).optional(),
+  direction: Direction$zodSchema.optional(),
+  start_at: z.string().datetime({ offset: true }).describe(
+    "An ISO-8601 formatted timestamp. When specified, assets created since that timestamp are returned.  Supported only if neither `prefix` nor `public_ids` were passed.",
+  ).optional(),
+  fields: z.array(FieldsSpec$zodSchema).optional(),
+};
+
+export const tool$assetsListVideos: ToolDefinition<typeof args> = {
+  name: "list-videos",
+  description: `Get video assets
+
+Retrieves a list of video assets. Results can be filtered by various criteria like tags, moderation status, prefix, or specific public IDs.
+`,
+  scopes: ["librarian"],
+  annotations: {
+    "title": "List Videos",
+    "destructiveHint": false,
+    "idempotentHint": true,
+    "openWorldHint": false,
+    "readOnlyHint": true,
+  },
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await assetsListVideos(
+      client,
+      args.type,
+      args.prefix,
+      args.public_ids,
+      args.tags,
+      args.next_cursor,
+      args.max_results,
+      args.direction,
+      args.start_at,
+      args.fields,
+      { fetchOptions: { signal: ctx.signal } },
+    ).$inspect();
+
+    if (!result.ok) {
+      return {
+        content: [{ type: "text", text: result.error.message }],
+        isError: true,
+      };
+    }
+
+    const value = result.value;
+
+    return formatResult(value, apiCall);
+  },
+};