Skip to main content
Glama

Update entity

update_entity
Destructive

Overwrite supplied display name, description, or complete brandConfig fields on an existing team entity. Omitted fields stay unchanged. Returns the updated entity. Built-in entities cannot be updated.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
nameNoNew display name. Omit to leave unchanged.
entityIdYesSaved reference entity to use. Obtain entityId from list_entities or create_entity.
brandConfigNoComplete replacement configuration for a BRAND entity.
descriptionNoNew description. Omit to leave unchanged.

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. Changed7 schema fields changed
    • addedInput schema / properties / brandConfig
      Added value: +{
      +  "description": "Complete replacement configuration for a BRAND entity.",
      +  "properties": {
      +    "colors": {
      +      "description": "Color guidance, including hex codes when available.",
      +      "type": "string"
      +    },
      +    "fonts": {
      +      "description": "Font guidance for a BRAND entity.",
      +      "type": "string"
      +    },
      +    "writingStyle": {
      +      "description": "Voice and tone for spoken and on-screen copy.",
      +      "type": "string"
      +    }
      +  },
      +  "required": [
      +    "fonts",
      +    "colors",
      +    "writingStyle"
      +  ],
      +  "type": "object"
      +}
    • 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

A4.2/5.0
Behavior4/5

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

Annotations already declare destructive non-read-only behavior, and the description adds that omitted fields stay unchanged and brandConfig is a complete replacement. It does not cover permissions or irreversibility beyond the destructive hint.

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 short sentences, front-loaded with the operation and partial-update behavior. 'Returns the updated entity' is slightly redundant because an output schema exists, but the text remains tight.

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 4-parameter mutation with full schema coverage, an output schema, and destructive annotation, the description covers mutation semantics, partial updates, brandConfig replacement, and built-in exclusion. Nothing required for correct invocation 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%, and the schema already documents name, entityId, description, and brandConfig including nested fields. The description restates partial-update and complete-replacement semantics but adds no syntax or format detail beyond the schema.

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 'Overwrite' and resource 'existing team entity' plus the affected fields. It also notes the built-in restriction and return behavior, distinguishing it from create/get/list/archive siblings.

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?

Explains this is for updating an existing entity and excludes built-in entities from updates. It does not name create_entity or archive_entity as alternatives, so routing is clear but not fully explicit.

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.