Skip to main content
Glama

VideoGen

by io.github.dg314
OverviewDiscussionsAdmin

Cancel tool execution

cancel_tool_execution
DestructiveIdempotent

Request cancellation of an API-started media generation or transformation. Pending work is stopped; completed files are not deleted. Any open review for a completed result is dismissed. Returns only toolExecutionId as an acknowledgment; use get_tool_execution to read status and results.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
toolExecutionIdYesExecution to inspect or cancel. Use toolExecutionId from a media-tool start result or list_tool_executions.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
toolExecutionIdYesExecution for which cancellation was requested.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed9 schema fields changed
    • changedInput schema / properties / toolExecutionId / description
      Previous value: -"Tool execution id (vg_tool_...)."New value: +"Execution to inspect or cancel. Use toolExecutionId from a media-tool start result or list_tool_executions."
    • changedOutput schema / description
      Previous value: -"Tool execution id, or full execution status after waiting (results when succeeded)."New value: +"Cancellation acknowledgment. Use get_tool_execution for status and results."
    • removedOutput schema / properties / attemptIndex
      Removed value: -{
-  "description": "Current or latest attempt index.",
-  "type": "number"
-}
    • removedOutput schema / properties / error
      Removed value: -{
-  "anyOf": [
-    {
-      "additionalProperties": {},
-      "properties": {
-        "code": {
-          "anyOf": [
-            {
-              "type": "string"
-            },
-            {
-              "type": "null"
-            }
-          ],
-          "description": "Machine-readable error code."
-        },
-        "internalErrorCode": {
-          "anyOf": [
-            {
-              "type": "string"
-            },
-            {
-              "type": "null"
-            }
-          ],
-          "description": "Opaque code for support."
-        },
-        "message": {
-          "description": "Human-readable error description.",
-          "type": "string"
-        },
-        "requirement": {
-          "anyOf": [
-            {
-              "additionalProperties": {},
-              "properties": {
-                "details": {
-                  "additionalProperties": {
-                    "type": "string"
-                  },
-                  "propertyNames": {
-                    "type": "string"
-                  },
-                  "type": "object"
-                },
-                "type": {
-                  "description": "Requirement type (e.g. purchase_add_on).",
-                  "type": "string"
-                }
-              },
-              "required": [
-                "type"
-              ],
-              "type": "object"
-            },
-            {
-              "type": "null"
-            }
-          ],
-          "description": "What is needed to resolve the error, when applicable."
-        }
-      },
-      "required": [
-        "message"
-      ],
-      "type": "object"
-    },
-    {
-      "type": "null"
-    }
-  ],
-  "description": "Error details when status is failed; otherwise null."
-}
    • removedOutput schema / properties / progressPercentage
      Removed value: -{
-  "description": "Completion progress 0-100 (present after polling).",
-  "type": "number"
-}
    • removedOutput schema / properties / results
      Removed value: -{
-  "description": "Generated results with download URLs when succeeded.",
-  "items": {
-    "additionalProperties": {},
-    "description": "One generated result from a succeeded tool execution.",
-    "properties": {
-      "downloadUrl": {
-        "anyOf": [
-          {
-            "type": "string"
-          },
-          {
-            "type": "null"
-          }
-        ],
-        "description": "Signed download URL."
-      },
-      "downloadUrlExpiresAt": {
-        "anyOf": [
-          {
-            "type": "number"
-          },
-          {
-            "type": "null"
-          }
-        ],
-        "description": "Unix expiry for downloadUrl."
-      },
-      "file": {
-        "additionalProperties": {},
-        "description": "Hydrated file metadata.",
-        "properties": {
-          "description": {
-            "anyOf": [
-              {
-                "type": "string"
-              },
-              {
-                "type": "null"
-              }
-            ],
-            "description": "File description when analyzed."
-          },
-          "displayName": {
-            "description": "Display name for the file.",
-            "type": "string"
-          },
-          "downloadSource": {
-            "anyOf": [
-              {
-                "additionalProperties": {},
-                "description": "A file rendition source (thumbnail, preview, download, …).",
-                "properties": {
-                  "expiresAt": {
-                    "anyOf": [
-                      {
-                        "type": "number"
-                      },
-                      {
-                        "type": "null"
-                      }
-                    ],
-                    "description": "Unix expiry for url."
-                  },
-                  "fileBytes": {
-                    "anyOf": [
-                      {
-                        "type": "number"
-                      },
-                      {
-                        "type": "null"
-                      }
-                    ],
-                    "description": "Rendition size in bytes."
-                  },
-                  "height": {
-                    "anyOf": [
-                      {
-                        "type": "number"
-                      },
-                      {
-                        "type": "null"
-                      }
-                    ],
-                    "description": "Rendition height in pixels."
-                  },
-                  "status": {
-                    "description": "Rendition status.",
-                    "enum": [
-                      "pending",
-                      "ready",
-                      "failed",
-                      "skipped"
-                    ],
-                    "type": "string"
-                  },
-                  "url": {
-                    "anyOf": [
-                      {
-                        "type": "string"
-                      },
-                      {
-                        "type": "null"
-                      }
-                    ],
-                    "description": "Signed URL when status is ready."
-                  },
-                  "width": {
-                    "anyOf": [
-                      {
-                        "type": "number"
-                      },
-                      {
-                        "type": "null"
-                      }
-                    ],
-                    "description": "Rendition width in pixels."
-                  }
-                },
-                "required": [
-                  "status"
-                ],
-                "type": "object"
-              },
-              {
-                "type": "null"
-              }
-            ]
-          },
-          "downloadUrl": {
-            "anyOf": [
-              {
-                "type": "string"
-              },
-              {
-                "type": "null"
-              }
-            ],
-            "description": "Signed download URL when ready."
-          },
-          "downloadUrlExpiresAt": {
-            "anyOf": [
-              {
-                "type": "number"
-              },
-              {
-                "type": "null"
-              }
-            ],
-            "description": "Unix expiry for downloadUrl."
-          },
-          "durationSeconds": {
-            "anyOf": [
-              {
-                "type": "number"
-              },
-              {
-                "type": "null"
-              }
-            ],
-            "description": "Duration in seconds for video/audio; null for images."
-          },
-          "fileId": {
-            "description": "File id (vg_file_...).",
-            "type": "string"
-          },
-          "hlsSource": {
-            "anyOf": [
-              {
-                "additionalProperties": {},
-                "description": "A file rendition source (thumbnail, preview, download, …).",
-                "properties": {
-                  "expiresAt": {
-                    "anyOf": [
-                      {
-                        "type": "number"
-                      },
-                      {
-                        "type": "null"
-                      }
-                    ],
-                    "description": "Unix expiry for url."
-                  },
-                  "fileBytes": {
-                    "anyOf": [
-                      {
-                        "type": "number"
-                      },
-                      {
-                        "type": "null"
-                      }
-                    ],
-                    "description": "Rendition size in bytes."
-                  },
-                  "height": {
-                    "anyOf": [
-                      {
-                        "type": "number"
-                      },
-                      {
-                        "type": "null"
-                      }
-                    ],
-                    "description": "Rendition height in pixels."
-                  },
-                  "status": {
-                    "description": "Rendition status.",
-                    "enum": [
-                      "pending",
-                      "ready",
-                      "failed",
-                      "skipped"
-                    ],
-                    "type": "string"
-                  },
-                  "url": {
-                    "anyOf": [
-                      {
-                        "type": "string"
-                      },
-                      {
-                        "type": "null"
-                      }
-                    ],
-                    "description": "Signed URL when status is ready."
-                  },
-                  "width": {
-                    "anyOf": [
-                      {
-                        "type": "number"
-                      },
-                      {
-                        "type": "null"
-                      }
-                    ],
-                    "description": "Rendition width in pixels."
-                  }
-                },
-                "required": [
-                  "status"
-                ],
-                "type": "object"
-              },
-              {
-                "type": "null"
-              }
-            ]
-          },
-          "isPublicPreviewEnabled": {
-            "type": "boolean"
-          },
-          "previewSource": {
-            "anyOf": [
-              {
-                "additionalProperties": {},
-                "description": "A file rendition source (thumbnail, preview, download, …).",
-                "properties": {
-                  "expiresAt": {
-                    "anyOf": [
-                      {
-                        "type": "number"
-                      },
-                      {
-                        "type": "null"
-                      }
-                    ],
-                    "description": "Unix expiry for url."
-                  },
-                  "fileBytes": {
-                    "anyOf": [
-                      {
-                        "type": "number"
-                      },
-                      {
-                        "type": "null"
-                      }
-                    ],
-                    "description": "Rendition size in bytes."
-                  },
-                  "height": {
-                    "anyOf": [
-                      {
-                        "type": "number"
-                      },
-                      {
-                        "type": "null"
-                      }
-                    ],
-                    "description": "Rendition height in pixels."
-                  },
-                  "status": {
-                    "description": "Rendition status.",
-                    "enum": [
-                      "pending",
-                      "ready",
-                      "failed",
-                      "skipped"
-                    ],
-                    "type": "string"
-                  },
-                  "url": {
-                    "anyOf": [
-                      {
-                        "type": "string"
-                      },
-                      {
-                        "type": "null"
-                      }
-                    ],
-                    "description": "Signed URL when status is ready."
-                  },
-                  "width": {
-                    "anyOf": [
-                      {
-                        "type": "number"
-                      },
-                      {
-                        "type": "null"
-                      }
-                    ],
-                    "description": "Rendition width in pixels."
-                  }
-                },
-                "required": [
-                  "status"
-                ],
-                "type": "object"
-              },
-              {
-                "type": "null"
-              }
-            ]
-          },
-          "publicHlsUrl": {
-            "anyOf": [
-              {
-                "type": "string"
-              },
-              {
-                "type": "null"
-              }
-            ]
-          },
-          "publicPlaybackId": {
-            "anyOf": [
-              {
-                "type": "string"
-              },
-              {
-                "type": "null"
-              }
-            ]
-          },
-          "scope": {
-            "description": "File scope.",
-            "enum": [
-              "GLOBAL",
-              "PROJECT",
-              "EXPORT",
-              "TEMPORARY",
-              "ENTITY"
-            ],
-            "type": "string"
-          },
-          "sourceToolExecutionId": {
-            "type": "string"
-          },
-          "sourceToolType": {
-            "type": "string"
-          },
-          "thumbnailSource": {
-            "anyOf": [
-              {
-                "additionalProperties": {},
-                "description": "A file rendition source (thumbnail, preview, download, …).",
-                "properties": {
-                  "expiresAt": {
-                    "anyOf": [
-                      {
-                        "type": "number"
-                      },
-                      {
-                        "type": "null"
-                      }
-                    ],
-                    "description": "Unix expiry for url."
-                  },
-                  "fileBytes": {
-                    "anyOf": [
-                      {
-                        "type": "number"
-                      },
-                      {
-                        "type": "null"
-                      }
-                    ],
-                    "description": "Rendition size in bytes."
-                  },
-                  "height": {
-                    "anyOf": [
-                      {
-                        "type": "number"
-                      },
-                      {
-                        "type": "null"
-                      }
-                    ],
-                    "description": "Rendition height in pixels."
-                  },
-                  "status": {
-                    "description": "Rendition status.",
-                    "enum": [
-                      "pending",
-                      "ready",
-                      "failed",
-                      "skipped"
-                    ],
-                    "type": "string"
-                  },
-                  "url": {
-                    "anyOf": [
-                      {
-                        "type": "string"
-                      },
-                      {
-                        "type": "null"
-                      }
-                    ],
-                    "description": "Signed URL when status is ready."
-                  },
-                  "width": {
-                    "anyOf": [
-                      {
-                        "type": "number"
-                      },
-                      {
-                        "type": "null"
-                      }
-                    ],
-                    "description": "Rendition width in pixels."
-                  }
-                },
-                "required": [
-                  "status"
-                ],
-                "type": "object"
-              },
-              {
-                "type": "null"
-              }
-            ]
-          },
-          "thumbnailUrl": {
-            "anyOf": [
-              {
-                "type": "string"
-              },
-              {
-                "type": "null"
-              }
-            ],
-            "description": "Signed thumbnail URL when available."
-          },
-          "thumbnailUrlExpiresAt": {
-            "anyOf": [
-              {
-                "type": "number"
-              },
-              {
-                "type": "null"
-              }
-            ],
-            "description": "Unix expiry for thumbnailUrl."
-          },
-          "transcriptText": {
-            "anyOf": [
-              {
-                "type": "string"
-              },
-              {
-                "type": "null"
-              }
-            ],
-            "description": "Plain transcript text when available."
-          },
-          "type": {
-            "anyOf": [
-              {
-                "type": "string"
-              },
-              {
-                "type": "null"
-              }
-            ],
-            "description": "File type once processing has determined it."
-          }
-        },
-        "required": [
-          "fileId"
-        ],
-        "type": "object"
-      },
-      "fileId": {
-        "description": "Generated file id (vg_file_...).",
-        "type": "string"
-      },
-      "thumbnailUrl": {
-        "anyOf": [
-          {
-            "type": "string"
-          },
-          {
-            "type": "null"
-          }
-        ],
-        "description": "Signed thumbnail URL, or null."
-      },
-      "thumbnailUrlExpiresAt": {
-        "anyOf": [
-          {
-            "type": "number"
-          },
-          {
-            "type": "null"
-          }
-        ],
-        "description": "Unix expiry for thumbnailUrl."
-      },
-      "type": {
-        "description": "Generated file type.",
-        "type": "string"
-      }
-    },
-    "required": [
-      "fileId",
-      "type",
-      "downloadUrl",
-      "downloadUrlExpiresAt",
-      "thumbnailUrl",
-      "thumbnailUrlExpiresAt",
-      "file"
-    ],
-    "type": "object"
-  },
-  "type": "array"
-}
    • removedOutput schema / properties / status
      Removed value: -{
-  "description": "Job status: pending, running, succeeded, failed, or cancelled.",
-  "enum": [
-    "pending",
-    "running",
-    "succeeded",
-    "failed",
-    "cancelled"
-  ],
-  "type": "string"
-}
    • changedOutput schema / properties / toolExecutionId / description
      Previous value: -"Tool execution id (vg_tool_...)."New value: +"Execution for which cancellation was requested."
    • removedOutput schema / properties / toolType
      Removed value: -{
-  "description": "Tool name (e.g. GENERATE_IMAGE).",
-  "type": "string"
-}
  2. First observed

TDQS

A4.5/5.0
Behavior5/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already declare destructiveHint=true and idempotentHint=true, yet the description adds real value beyond them: pending work stops, completed files survive, open reviews are dismissed, and only toolExecutionId is returned. These are exactly the side-effect details an agent needs before invoking a destructive operation.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Four tight sentences, front-loaded with the action, followed by side effects and then the return/routing note. Every sentence earns its place.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given an output schema exists, the description needn't explain returns, but it still notes the minimal acknowledgment and where to read results. Combined with the side-effect disclosure, nothing needed to call this correctly is missing.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, so the single parameter is fully documented in the schema (including provenance from a start result or list_tool_executions). The description adds no parameter-specific syntax or format detail, so the baseline 3 applies.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb (cancel) and resource (tool execution), and scopes it to 'API-started media generation or transformation', which separates it from siblings like get_tool_execution and list_tool_executions. An agent can identify the operation without opening the schema.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description makes clear this is for stopping pending work and points to get_tool_execution for reading status afterward. It does not explicitly state when-not to use it (e.g., versus cancel_workflow_run), but the 'API-started' qualifier narrows applicability usefully.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

All VideoGen toolsInspect
Try in Browser
One endpoint for every MCP toolRayrun runs every MCP server behind one URL and holds the credentials. Each call is decided per client, tool, and argument, then recorded.ray.runAd

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources