Skip to main content
Glama

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.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
entityIdYesSaved reference entity to use. Obtain entityId from list_entities or create_entity.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
nameYesDisplay name.
entityIdYesEntity id (vg_enti_...).
createdAtYesUnix created-at timestamp.
isBuiltInNoTrue for VideoGen catalog entities that cannot be modified.
updatedAtYesUnix updated-at timestamp.
entityTypeYesACTOR, PRODUCT, VISUAL_STYLE, SLIDESHOW_THEME, BRAND, LOCATION, or PROP.
referencesYesAttached reference images.
actorConfigNoVoice/avatar summary for ACTOR entities; null for other types.
brandConfigNoBrand guidance for BRAND entities; null for other types.
descriptionYesDescription (empty when unset).

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • 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."
  2. Changed6 schema fields changed
    • 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"
      +]
  3. First observed

TDQS

A3.8/5.0
Behavior4/5

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

Annotations already declare readOnly/idempotent/non-destructive, so the safety profile is covered. The description adds genuinely new behavioral context beyond them: the response includes reference images, built-in catalog entities are returned as well, and those carry an isBuiltIn flag. That is real return-content disclosure the annotations do not provide.

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 immediately followed by the most useful return detail. No filler, no repetition of the title.

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, full annotation coverage, and a fully described single parameter, the definition is nearly self-sufficient. The one thing left implicit is the relationship to list_entities/create_entity for obtaining the id, which the schema happens to cover anyway.

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% and the entityId parameter already documents its own origin (list_entities or create_entity). The description's 'by id' adds no format, type, or sourcing detail beyond the schema, so the baseline of 3 is appropriate.

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?

States a specific verb and resource: fetch one entity by id, and adds the scope qualifier 'one' that distinguishes it from the sibling list_entities. It never explicitly names the sibling tools, but the singular/plural contrast makes the retrieval semantics unambiguous.

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: an agent infers it should call this when it has a single entityId and wants that record. There is no explicit when-to-use vs list_entities or when-not guidance, and no statement that the id can be sourced from list_entities or create_entity (that lives only in the schema).

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.