VideoGen

Get entity

get_entity

Read-onlyIdempotent

Fetch one entity by id, including its reference images. Built-in catalog entities are included and have isBuiltIn true.

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>"
    },
    "name": "get_entity"
  }
}

Input Schema

Name	Required	Description	Default
`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

A3.8/5.0

Behavior4/5

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

Annotations already declare this a read-only, idempotent, non-destructive operation, so the bar is low. The description still adds real behavioral context beyond that: reference images are included in the result, and built-in catalog entities are returned with isBuiltIn true, which an agent could not otherwise anticipate.

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?

Two short sentences, front-loaded with the core action and followed by the one non-obvious caveat. 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?

With an output schema covering return values and annotations covering the safety profile, the description is close to complete for a single-parameter read. It omits only failure behavior when an id does not resolve, a minor gap.

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 the entityId parameter and its provenance are fully documented in the schema. The description only restates "by id" and adds no format, validation, or sourcing detail beyond what the schema already provides.

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

Purpose4/5

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

"Fetch one entity by id" gives a specific verb, resource, and cardinality, which implicitly distinguishes it from the sibling list_entities. It does not explicitly name the alternative, but the singular "one entity by id" is enough for an agent to choose correctly.

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 only implied: fetch when you already have an id. The guidance to obtain entityId "from list_entities or create_entity" is present, but that lives in the schema rather than the description. No exclusions or when-not conditions are stated.

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.