Skip to main content
Glama

Get Brand Edit

get_brand_edit
Idempotent

Read a brand edit's progress, requested input, or prepared candidate. Set wait to true to wait while its status is preparing; if the result is still preparing, repeat the same read with wait: true. On supported MCP clients, this call may accept native input and resume preparation when the question and response can be represented completely. Otherwise use continue_brand_edit. Resuming does not change the active 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": {
      "edit_id": "<edit_id>"
    },
    "name": "get_brand_edit"
  }
}

Input Schema

NameRequiredDescriptionDefault
waitNoWait while the edit is preparing, until its status changes or the timeout expires. Defaults to false.
edit_idYesUse edit_id returned by create_brand_edit to identify the Brand Edit draft.
timeoutNoHow long this read may wait, in seconds, including setup, native-input continuation, and polling. Applies when wait is true. Defaults to and is capped at 45 seconds.
llm_modelNoThe model identifier you are running as, for example "claude-opus-4-8" or "gpt-5.2". Omit it or pass "unknown" if you are not certain; the tool runs the same either way. Recorded only for the server developer's analytics.

Output Schema

NameRequiredDescriptionDefault
errorYes
statusYes
targetYes
edit_idYes
change_setYesDifferences between the base Brand Skill and the prepared candidate, or null before a candidate exists.
created_atYes
updated_atYes
interactionYesThe current request for user input, or null when no response is requested.
replacementYes
base_skill_idYes
change_summaryYesA summary of the candidate's proposed changes, or null when no summary is available.
status_messageYesAn explanation of the edit's current status; a prepared candidate does not change the active brand until applied.
target_profileYesThe candidate's brand profile, which becomes active only on Apply, or null before a candidate exists.
brand_session_idYes
message_for_assistantNoContext, explanations, or actionable guidance for the calling assistant. Hosts may display it, but it is not copy that must be shown to the user verbatim.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.2/5.0
Behavior4/5

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

Annotations declare readOnlyHint=false, destructiveHint=false and idempotentHint=true, and the description explains the non-read-only aspect by disclosing that the call may resume preparation on supported clients — resolving what would otherwise look contradictory. It further reassures with 'Resuming does not change the active brand,' a behavioral fact not present in annotations or schema. It stops short of describing the shape of the returned progress or error conditions, but with an output schema present that gap is acceptable.

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 sentences, front-loaded with the read purpose, then the wait protocol, then the client-specific continuation caveat and the fallback. Every sentence carries actionable content; the phrasing 'On supported MCP clients...' is slightly dense but not wasteful.

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 tool with 4 parameters, full schema coverage, annotations, and an output schema, the description covers the essential agent decisions: what is read, how to wait, when to repeat, and which sibling to fall back to. Detail about the returned 'requested input' format is delegated to the output schema, which is appropriate.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, so the baseline would be 3, but the description earns more by explaining the retry semantics of wait (repeat the same read while still preparing) rather than merely restating the schema's timeout claim. It does not mention llm_model, though the schema already documents it as analytics-only, so no meaning is lost.

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?

The description opens with a specific verb and resource: 'Read a brand edit's progress, requested input, or prepared candidate,' which tells the agent exactly what is returned and distinguishes it from the mutation-oriented sibling continue_brand_edit. It is slightly muddied by the added clause about accepting native input and resuming preparation, but the primary purpose remains clear.

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

Usage Guidelines5/5

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

It gives an explicit operational loop: 'Set wait to true to wait while its status is preparing; if the result is still preparing, repeat the same read with wait: true.' It also names the alternative and the condition that selects it: 'Otherwise use continue_brand_edit.' Nothing about when to call this vs. that is left to inference.

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