Skip to main content
Glama

ZeroRank - Track and improve your AI search visibility

update_brand

Idempotent

Update a brand's name, aliases, domains, regex matching, status, or color. The own brand cannot be hidden. Suggested brands transition only via approve_suggested_brands / reject_suggested_brands.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYesThe brand ID
nameNoNew brand name
colorNoHex color, e.g. "#3b82f6" (note: brand colors are hex; TAG colors are named)
statusNo'active' (tracked) or 'hidden' (not tracked)
domainsNoReplacement domain list (null clears it)
useRegexNo
nameRegexNo
workspaceIdYesWorkspace ID — get the list from the list_workspaces tool
trackedNamesNoReplacement alias list (null clears it)

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4/5.0
Behavior4/5

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

Annotations already declare non-readOnly, idempotent, non-destructive, so the safety profile is covered. The description adds genuine behavioral context beyond them: the own-brand hiding restriction and the fact that suggested brands must be transitioned through approve/reject tools rather than this one.

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 tight sentences with no filler; the field list comes first and the routing constraints are front-loaded immediately after. Every clause carries 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 9-parameter mutation tool with no output schema, the description supplies the mutable-field set and the key usage constraints, and annotations cover safety. Minor gaps remain (partial-update semantics, whether omitted fields are preserved), but nothing critical 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 description coverage is 78%, so the schema already documents most parameters (including null-clears semantics and the hex-color note). The description's field list roughly mirrors the schema without adding format or constraint detail, so baseline 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 (Update) and resource (brand) and enumerates the mutable fields (name, aliases, domains, regex matching, status, color), letting an agent distinguish it from create_brand, delete_brand, and get_brand. It does not, however, explicitly name update-siblings it might be confused with, so it stops short of a 5.

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?

Gives concrete when/when-not guidance: 'The own brand cannot be hidden' and 'Suggested brands transition only via approve_suggested_brands / reject_suggested_brands', which routes the agent away from this tool for suggestion workflows. It covers exclusions well but does not describe general preconditions (e.g. needing the brand to exist or workspace scoping).

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.

Resources