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.

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": "update_entity"
  }
}

Input 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

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
    • 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"
      +  }
      +]
  2. 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."
  3. 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"
      +]
  4. 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 destructiveHint=true and idempotentHint=false, and the description corroborates this by stating brandConfig is a complete replacement while omitted fields stay unchanged — a distinction the annotations do not convey. It also discloses the return value and the built-in-entity restriction. It does not cover permission requirements or what happens to nested brandConfig sub-fields not supplied, which is the remaining gap for a destructive mutation.

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?

Four short sentences, front-loaded with the mutation scope, followed by the patch semantics, the return value, and the exclusion. Nothing is repeated and nothing could be removed without losing information.

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?

For a 4-parameter destructive mutation with full schema coverage, an output schema, and rich annotations, the description covers the essential semantics: replacement versus omission, return value, and the built-in exclusion. Only permission/auth requirements and error behavior beyond the built-in case are absent, which is a minor shortfall.

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 every parameter is already documented, and the description only reinforces the non-obvious semantics: partial update for name/description versus whole-object replacement for brandConfig. That is a useful nudge but adds no syntax, format, or constraint detail beyond the schema, so 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 (overwrite) plus the exact resource (existing team entity) and the three updatable fields. The word 'existing' and the built-in restriction separate it from create_entity without the agent needing to open either 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?

Clear context is given: omit a field to leave it unchanged, and built-in entities cannot be updated. What is missing is an explicit pointer to an alternative (e.g. create_entity for new entities, or archive_entity when removal rather than editing is wanted), so it falls short of full when/when-not/alternative coverage.

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.