Skip to main content
Glama

Get Brand

get_brand
Read-onlyIdempotent

Get a brand's status, profile, guidance, and files. Read any file with view_files. Set wait to true to wait for current brand initialization. A version_id read returns that exact immutable version immediately, even if it is currently the latest. If the result is still analyzing, repeat the same read with wait: true. Use profile.logo_catalog to select among supported logos for the selected version. Follow exact caller selection and relevant Brand Skill guidance before contrasts_best_on visibility hints; use the primary logo as a general fallback. Null means no catalog was published, while an empty items array records no supported logos. Pass the same version_id when refreshing temporary asset URLs to retain the selected version.

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": {
      "brand_session_id": "<brand_session_id>"
    },
    "name": "get_brand"
  }
}

Input Schema

NameRequiredDescriptionDefault
waitNoWait for current brand initialization to finish or the timeout to expire. Defaults to false. Ignored when version_id is provided.
timeoutNoHow long this read may wait for Brand initialization, in seconds, including setup and polling. Applies when wait is true and version_id is omitted. 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.
version_idNoVersion ID from list_brand_versions identifying the exact saved snapshot to read. Omit to read the latest version.
brand_session_idYesBrand session ID from `list_brands`.

Output Schema

NameRequiredDescriptionDefault
filesNoComplete file list for the returned version. Use exact paths with view_files; description previews help choose which files to read.
statusYesBrand readiness for this read. An analyzing result may require another read with wait enabled.
failureYesFailure details, or null when the Brand has not failed.
profileNoStructured identity for the returned Brand version, when available.
brand_urlYesPage for opening this Brand in the app.
created_atYesTime the Brand was created.
version_idNoImmutable Brand version returned by this read. Pass it as version_id to view_files to read files from the same version. Omitted when no canonical version is available.
file_catalogNoPath completeness and the maximum number of exact paths per view_files call.
workspace_idYesWorkspace ID, or null for a personal workspace that has no ID.
root_guidanceNoContents of SKILL.md for the returned Brand version, when available.
workspace_nameYesName of the workspace that owns this Brand.
brand_session_idYesBrand session ID to reuse in subsequent Brand tool calls.
navigation_guideNoTask-specific file selections parsed from the Brand Skill. Omitted when no navigation guidance is available.
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.1/5.0
Behavior4/5

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

The annotations already declare readOnlyHint, idempotentHint, and destructiveHint=false, so the bar is lower, yet the description still adds real behavior: waiting semantics, retry-on-analyzing guidance, and the immutability guarantee that a version_id read returns that exact snapshot even when it is the latest. The null-versus-empty-array distinction for profile.logo_catalog is useful disclosure. It does not cover output shape, which is acceptable since an output schema exists.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness3/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The core read behavior is front-loaded, but the paragraph drifts into logo-catalog selection hints, Brand Skill guidance, and contrasts_best_on visibility guidance that are tangential to invoking this tool. Several sentences, such as the fallback-logo advice, could be trimmed without losing invocation-critical 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 five-parameter read tool with a full output schema and read-only annotations, the definition covers what an agent needs: version selection, waiting behavior, file delegation, and catalog edge cases. The only gaps are stylistic drift into downstream guidance rather than missing invocation details.

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 description coverage is 100%, so the baseline is 3. The description still adds meaning beyond the schema by tying version_id to version retention when refreshing temporary asset URLs and by explaining the retry loop that motivates the wait parameter. The wait and timeout semantics are largely restated from the schema, but the version-pinning guidance is genuinely additive.

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 opening sentence names a specific verb and enumerates the resource's parts: status, profile, guidance, and files. It also routes file content to the view_files sibling, which helps distinguish the two. It stops short of explicitly contrasting with the edit-oriented siblings like get_brand_edit, so it is clear but not fully differentiated.

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?

The description gives concrete when-to guidance: use view_files to read file content, set wait to true to await initialization, re-issue the same read with wait:true if the result is still analyzing, and reuse the same version_id when refreshing temporary asset URLs. It also explains the version_id read path versus the default latest-version read. That is explicit instruction with alternatives rather than implied usage.

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