Skip to main content
Glama
ghl-mcp-server-v2

ghl-mcp-server-v2

by zackscriven

ghl_brand_board_get_by_id

Read-onlyIdempotent

Retrieves a specific Brand Board by its ID and location ID, enabling inspection of a sub-account's brand board details.

Instructions

[LEGACY FALLBACK — this endpoint is no longer in the live v3 docs (checked 2026-10-28) but is still served under the legacy Version header. Expect removal; prefer a current equivalent.] Get Brand Board Retrieves a specific Brand Board by its ID Endpoint: GET /brand-boards/{locationId}/{id} (Version header: 2021-07-28; source: brand-boards.json) Requires a Sub-Account (location) token. OAuth scopes: brand-boards/design-kit.readonly

Input Schema

NameRequiredDescriptionDefault
idYesBrand board ID to update, retrieve, or delete
locationIdYesLocation ID where the brand board exists

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv2.0.0

TDQS

A4.1/5.0
Behavior5/5

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

The description adds important behavior beyond the annotations: it requires a Sub-Account token, names the required OAuth scope, specifies the Version header, and discloses the legacy/deprecation status. These are operationally significant details an agent could not infer from `readOnlyHint`, `idempotentHint`, or `openWorldHint` alone.

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 legacy warning is appropriately front-loaded, followed by the operation summary, endpoint, auth requirement, and scopes. It is compact and structured, though the repeated 'Get Brand Board / Retrieves...' phrasing is slightly redundant.

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?

For a read-only get-by-ID tool with full schema coverage and no output schema, the description covers everything needed: purpose, endpoint, auth token type, OAuth scope, and legacy status. There are no material omissions.

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 coverage is 100%, so both `locationId` and `id` are already documented in the input schema. The description confirms the path structure but adds no further syntax, constraints, or format details beyond what the schema provides. 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?

The description clearly states the verb and resource: it retrieves a specific Brand Board by ID. It also gives the exact endpoint, making the object being fetched unambiguous. It does not explicitly distinguish itself from sibling `ghl_brand_board_get_by_location`, so it falls 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?

It gives strong contextual guidance by marking the endpoint as a legacy fallback, noting it is absent from current v3 docs, and warning that removal is expected. The phrase 'prefer a current equivalent' tells the agent to avoid it when possible, though it does not name the specific alternative.

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

Deploy Server

Other Tools