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.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "entityId": "<entityId>",
      "fileId": "<fileId>"
    },
    "name": "remove_entity_reference"
  }
}

Input 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

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 changedNov 4, 2026

changedOutput schema / properties / actorConfig / anyOf

Previous value: -[
-  {
-    "additionalProperties": {},
-    "properties": {
-      "hasAvatarPresenter": {
-        "description": "True when the actor has an image reference usable for avatar generation.",
-        "type": "boolean"
-      },
-      "hasVoice": {
-        "description": "True when the actor has a configured voice.",
-        "type": "boolean"
-      },
-      "voiceDisplayName": {
-        "anyOf": [
-          {
-            "type": "string"
-          },
-          {
-            "type": "null"
-          }
-        ],
-        "description": "Configured voice display name when set."
-      }
-    },
-    "required": [
-      "hasVoice",
-      "hasAvatarPresenter"
-    ],
-    "type": "object"
-  },
-  {
-    "type": "null"
-  }
-]New value: +[
+  {
+    "additionalProperties": {},
+    "properties": {
+      "hasAvatarPresenter": {
+        "description": "True when the actor has an image reference usable for avatar generation.",
+        "type": "boolean"
+      },
+      "hasVoice": {
+        "description": "True when the actor has a configured voice.",
+        "type": "boolean"
+      },
+      "voiceDisplayName": {
+        "description": "Configured voice display name when set.",
+        "type": [
+          "string",
+          "null"
+        ]
+      }
+    },
+    "required": [
+      "hasVoice",
+      "hasAvatarPresenter"
+    ],
+    "type": "object"
+  },
+  {
+    "type": "null"
+  }
+]

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/5.0

Behavior4/5

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

Annotations already declare destructiveHint=true, readOnlyHint=false, and idempotentHint=true, but the description adds substantive behavior beyond them: soft-archive semantics, default-reference promotion, the return payload, and the built-in-entity restriction. One tension worth noting: 'Retrying a removed attachment can fail because it is no longer active' sits awkwardly against idempotentHint=true, though strictly the server state is unchanged, so it is a caveat 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 sentences, front-loaded with the verb and the most important reassurance (source file preserved), followed by side effects, return value, and failure mode. Every sentence carries information; the only minor cost is that it reads as a dense paragraph rather than scannable clauses.

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?

For a two-parameter mutation tool, the description covers the safety profile, the side effect on default references, the return shape, a retry pitfall, and a hard precondition on built-in entities. An output schema exists, so return values need not be spelled out further, and nothing an agent needs 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 description coverage is 100%, so both parameters (fileId and entityId) are already documented in the schema, including the vg_file_ prefix and the list_entities/create_entity provenance hint. The description adds no syntax, format, or edge-case detail about either parameter, 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 without deleting the source file.' The 'soft-archive ... without deleting the source file' phrasing clearly separates it from archive_entity and from any file-deletion operation, and the inverse sibling add_entity_reference is unambiguous from the name.

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

Usage Guidelines3/5

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

Usage is implied rather than stated: the description clarifies what the operation does NOT do (delete the source file) and gives one hard exclusion ('Built-in entities cannot have references removed'), which is a real precondition. However, it never names an alternative tool or states the condition under which an agent should prefer add_entity_reference, update_entity, or archive_entity instead, so routing is left to inference.

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.