VideoGen

Remove entity reference

remove_entity_reference

DestructiveIdempotent

Soft-archive a reference attachment on a team entity without deleting the source file. If it was the default reference, another reference is promoted when available. Returns the entity with its remaining references. Retrying a removed attachment can fail because it is no longer active. Built-in entities cannot have references removed.

Input Schema

TableJSON Schema

Name	Required	Description	Default
`fileId`	Yes	Reference image file id (vg_file_...) to remove.
`entityId`	Yes	Saved reference entity to use. Obtain entityId from list_entities or create_entity.

Output Schema

TableJSON Schema

Name	Required	Description
`name`	Yes	Display name.
`entityId`	Yes	Entity id (vg_enti_...).
`createdAt`	Yes	Unix created-at timestamp.
`isBuiltIn`	No	True for VideoGen catalog entities that cannot be modified.
`updatedAt`	Yes	Unix updated-at timestamp.
`entityType`	Yes	ACTOR, PRODUCT, VISUAL_STYLE, SLIDESHOW_THEME, BRAND, LOCATION, or PROP.
`references`	Yes	Attached reference images.
`actorConfig`	No	Voice/avatar summary for ACTOR entities; null for other types.
`brandConfig`	No	Brand guidance for BRAND entities; null for other types.
`description`	Yes	Description (empty when unset).

Schema Changelog

Changes observed during successful MCP inspections.

Changed1 schema field changedOct 16, 2026

changedInput schema / properties / entityId / description

Previous value: -"Entity id (vg_enti_...)."New value: +"Saved reference entity to use. Obtain entityId from list_entities or create_entity."

Changed6 schema fields changedOct 16, 2026

changedOutput schema / description

Previous value: -"A reusable actor, product, visual style, or slideshow theme entity."New value: +"A reusable actor, product, visual style, slideshow theme, brand, location, or prop entity."

addedOutput schema / properties / brandConfig

Added value: +{
+  "anyOf": [
+    {
+      "additionalProperties": false,
+      "properties": {
+        "colors": {
+          "description": "Color guidance.",
+          "type": "string"
+        },
+        "fonts": {
+          "description": "Font guidance.",
+          "type": "string"
+        },
+        "writingStyle": {
+          "description": "Voice and tone for copy.",
+          "type": "string"
+        }
+      },
+      "required": [
+        "fonts",
+        "colors",
+        "writingStyle"
+      ],
+      "type": "object"
+    },
+    {
+      "type": "null"
+    }
+  ],
+  "description": "Brand guidance for BRAND entities; null for other types."
+}

changedOutput schema / properties / entityType / description

Previous value: -"ACTOR, PRODUCT, VISUAL_STYLE, or SLIDESHOW_THEME."New value: +"ACTOR, PRODUCT, VISUAL_STYLE, SLIDESHOW_THEME, BRAND, LOCATION, or PROP."

changedOutput schema / properties / entityType / enum

Previous value: -[
-  "ACTOR",
-  "PRODUCT",
-  "VISUAL_STYLE",
-  "SLIDESHOW_THEME"
-]New value: +[
+  "ACTOR",
+  "PRODUCT",
+  "VISUAL_STYLE",
+  "SLIDESHOW_THEME",
+  "BRAND",
+  "LOCATION",
+  "PROP"
+]

addedOutput schema / properties / references / items / properties / role

Added value: +{
+  "description": "REFERENCE for generation and thumbnails; BRAND_LOGO / BRAND_STYLE_GUIDE for a brand's logo and style guide.",
+  "enum": [
+    "REFERENCE",
+    "BRAND_LOGO",
+    "BRAND_STYLE_GUIDE"
+  ],
+  "type": "string"
+}

changedOutput schema / properties / references / items / required

Previous value: -[
-  "fileId",
-  "description",
-  "isDefault"
-]New value: +[
+  "fileId",
+  "description",
+  "role",
+  "isDefault"
+]

First observedOct 9, 2026

TDQS

A4.1/5.0

Behavior4/5

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

The description adds substantial texture beyond the annotations: it discloses the operation is a soft-archive (not a hard delete), that a default reference promotes a replacement, that the response is the entity with its remaining references, and that built-in entities are ineligible. The 'retrying can fail because it is no longer active' note sits in mild tension with idempotentHint=true, though soft-archiving is still idempotent in effect, so this is a nuance rather than a contradiction.

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

Conciseness4/5

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

Four compact sentences, each front-loading the most important fact (soft-archive, no source deletion) with no filler. Slightly dense and the return-value sentence is partly redundant given an output schema exists, but nothing is wasted.

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

Completeness4/5

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

Given an output schema already exists, the description need not explain the return payload, yet it usefully confirms what comes back. Combined with the soft-archive semantics, default-promotion behavior, retry caveat, and built-in restriction, it is complete enough for correct invocation.

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 description coverage is 100%, so both parameters are fully documented in the schema. The description adds no syntax, format, or constraint detail about entityId/fileId beyond what the schema states, 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 and resource: 'Soft-archive a reference attachment on a team entity.' The scope (reference attachment vs. source file) and the contrast with sibling tools add_entity_reference and archive_entity are unambiguous, so an agent can select it 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?

Provides a clear exclusion ('Built-in entities cannot have references removed') and a safety precondition ('without deleting the source file'), giving the agent solid context for when the call is valid. It stops short of explicitly naming an alternative tool or the when-to-use-vs-sibling routing, which keeps it below 5.

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

All VideoGen tools Inspect

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.