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

ghl-mcp-server-v2

by zackscriven

ghl_brand_board_get_by_location

Read-onlyIdempotent

Retrieves all Brand Boards for a specific location, with pagination, name search, and optional inclusion of deleted boards.

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 Boards Retrieves all Brand Boards for a specific location Endpoint: GET /brand-boards/{locationId} (Version header: 2021-07-28; source: brand-boards.json) Requires a Sub-Account (location) token. OAuth scopes: brand-boards/design-kit.readonly Pagination params: limit, offset — pass them to page through full result sets.

Input Schema

NameRequiredDescriptionDefault
limitNoMaximum number of brand boards to return
offsetNoNumber of brand boards to skip for pagination
searchNoSearch term to filter brand boards by name
deletedNoInclude deleted brand boards in results
locationIdYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changedv2.1.0
    • removedInput schema / properties / locationId / description
      Removed value: -"Location ID where the brand boards exist"
    • removedInput schema / properties / locationId / example
      Removed value: -"ve9EPM428h8vShlRW1KT"
  2. First observedv2.0.0

TDQS

A4.1/5.0
Behavior4/5

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

Annotations already cover readOnly/idempotent/openWorld, but the description adds real context beyond them: Sub-Account token requirement, the brand-boards/design-kit.readonly OAuth scope, and pagination semantics for full result sets. It omits any sense of result shape or empty-state behavior, keeping it below 5.

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 deprecation warning is front-loaded in brackets, then purpose, endpoint, auth, scopes and pagination in a tight block. The sentence-count is justified, though the bracketed caveat is verbose enough to slightly dilute the opening.

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 read-only list endpoint with no output schema, it covers the things an agent needs to call it successfully: location scoping, token type, required scope, and paging. It doesn't mention the search/deleted filters the schema exposes or the default page size, a minor gap.

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 80%, so the schema already documents limit, offset, search and deleted. The description only reiterates limit/offset as 'pagination params' and says nothing about search or deleted, adding no meaning beyond the structured fields – baseline 3.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb and resource ('Get/Retrieves all Brand Boards') plus the scoping axis ('for a specific location'), which cleanly separates it from the sibling ghl_brand_board_get_by_id. The endpoint line reinforces the exact resource path.

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?

Explicitly flags that this is a legacy fallback absent from live v3 docs and advises 'prefer a current equivalent', which is genuine when-to-use guidance including a caution. It falls short of 5 because it never names the specific replacement tool, leaving the agent to search for it.

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