MCP VTEX Server

vtex_update_brand

Update existing brand information in VTEX e-commerce platform, including name, description, and active status, to maintain accurate catalog data.

Instructions

Update an existing brand

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": {
      "brandId": "<brandId>"
    },
    "name": "vtex_update_brand"
  }
}

Input Schema

Name	Required	Description
`brandId`	Yes	Brand ID
`Name`	No	Brand name
`Text`	No	Brand description
`Active`	No	Brand active status

Schema Changelog

Changes observed during successful MCP inspections.

First observedv1.0.0Jan 10, 2026

TDQS

C2.7/5.0

Behavior2/5

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

No annotations are provided, so the description carries full burden. It states this is an update operation, implying mutation, but doesn't disclose behavioral traits like required permissions, whether changes are reversible, error handling, or rate limits. For a mutation tool with zero annotation coverage, this is a significant gap in transparency.

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?

The description is a single, efficient sentence with zero waste. It's appropriately sized and front-loaded, directly stating the tool's purpose without unnecessary elaboration. Every word earns its place.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given this is a mutation tool with 4 parameters, no annotations, and no output schema, the description is incomplete. It doesn't cover behavioral aspects, error cases, or what the tool returns. For a tool that modifies data, more context is needed to ensure safe and correct usage.

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%, with all parameters (brandId, Name, Text, Active) documented in the schema. The description doesn't add any meaning beyond what the schema provides—it doesn't explain parameter interactions, defaults, or constraints. Baseline 3 is appropriate when the schema does the heavy lifting.

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

Purpose3/5

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

The description 'Update an existing brand' clearly states the action (update) and resource (brand), but it's vague about what aspects can be updated. It distinguishes from sibling tools like vtex_create_brand and vtex_delete_brand by specifying 'existing', but doesn't differentiate from other update tools like vtex_update_category or vtex_update_product beyond the resource type.

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

Usage Guidelines2/5

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

No guidance is provided on when to use this tool versus alternatives. The description doesn't mention prerequisites (e.g., needing a brandId), when not to use it (e.g., for creating new brands), or how it relates to sibling tools like vtex_get_brand (for reading) or vtex_delete_brand. Usage is implied by the action 'update' but not explicitly stated.

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

Deploy Server