Skip to main content
Glama

Get workspace

get_brand
Read-onlyIdempotent

Use this tool when the user wants to see their sites and pages together, or when many pages are made or fixed at once: 「サイトのページを全部見せて」「うちのホームページにどのページがある?」, "which pages do we have on our domain?", "plan guide pages for AI answers" (ホームページ, Webサイト, ランディングページ). Other tools work without calling it first.

Returns the workspace (the tools call it a brand): id (expectedBrandId on the write tools takes it), name, hostLabel (its convika.page site is .convika.page; null until the first page names it), mainUrl, and its sites. kind says what each site is: managed (the convika.page site), custom (a site on the owner's own domain, connected to Convika), or external (a store or a social page elsewhere, with no pages here). Each managed or custom site lists its pages, top-level paths first, with id (the siteId the other tools take), name, path, status (draft, preview, or production for live), and url: up to 100 a site, fewer when the reply would pass about 6,000 tokens. pageCount is each site's total and morePages what isn't shown; list_pages lists those. Read-only.

Input Schema

NameRequiredDescriptionDefault

No arguments

Output Schema

NameRequiredDescriptionDefault
idYes
nameNo
sitesYes
mainUrlNo
guidanceNo
hostLabelNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A4.3/5.0
Behavior5/5

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

Beyond the annotations, the description explains return structure, site kinds, hostLabel null behavior, page listing limits (up to 100 per site or roughly 6,000 tokens), and how pageCount/morePages signal omitted pages. This adds substantial behavioral context for a read-only retrieval tool.

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?

The description is front-loaded with usage guidance followed by return details, and most content is relevant. It is somewhat long and includes multiple examples and field explanations, but the length is justified by the complexity of the returned workspace structure.

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

Completeness5/5

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

Given the rich annotations and output schema, the description still provides enough additional context about when to call it and what the returned workspace contains. It also covers pagination behavior and the meaning of key fields, leaving no major gaps for an agent.

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?

The tool takes zero parameters, so the baseline is 4. The description appropriately focuses on output semantics rather than inventing parameter guidance.

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 clearly states that the tool returns the workspace/brand along with its sites and pages, and it clarifies the brand/workspace naming mismatch. It is distinguishable from list_pages for omitted pages, but it does not explicitly differentiate itself from siblings like get_site or list_sites.

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?

It gives concrete usage conditions: seeing sites and pages together, or when many pages are being created or fixed at once, with example user phrases. It also notes that other tools work without calling it first and points to list_pages for pages not shown, though it does not explicitly contrast with get_site or list_sites.

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.