Skip to main content
Glama

List locations

list_locations
Read-only

The connected locations (a business, app, shop or listing on one platform), with their id, platform, status and reference (the customer’s own id for it, like an office number). sync_status says what each is doing: queued, importing, waiting_for_reads, ready or error, with sync_status_reason, estimated_ready_at and reviews_imported. A location that is not ready yet has no reviews because its import hasn’t finished, not because something broke: tell the user its reason.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "list_locations"
  }
}

Input Schema

NameRequiredDescriptionDefault
referenceNoOnly locations with this reference (several separated by commas).

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • addedInput schema / properties / reference
      Added value: +{
      +  "description": "Only locations with this reference (several separated by commas).",
      +  "type": "string"
      +}
  2. First observed

TDQS

A3.8/5.0
Behavior4/5

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

Annotations already establish this is a safe read (readOnlyHint=true, destructiveHint=false), so the bar is lower, and the description clears it by disclosing the returned status vocabulary (queued, importing, waiting_for_reads, ready, error) plus the sync_status_reason, estimated_ready_at and reviews_imported fields. It also pre-empts a likely misdiagnosis — no reviews means the import is unfinished, not a failure — which is behavioral context annotations cannot convey.

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?

Purpose and returned fields are front-loaded in the first sentence, with status semantics and the not-ready caveat following logically. The prose is dense and the parenthetical definition is slightly long, but no sentence is filler — each adds field or interpretation 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?

With no output schema, the description carries the return-value burden and does so by naming the key fields and the status enum, which is what an agent needs to render results. The main residual gap is the absence of pagination or result-size guidance, which matters for a list tool.

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?

With a single parameter at 100% schema coverage, the baseline would be 3, but the description adds real meaning by explaining that 'reference' is the customer's own identifier for the location (e.g. an office number), not an internal id. The comma-separated multi-value syntax is left to the schema, but the semantic gloss on reference is a genuine increment.

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 defines the resource precisely — 'connected locations (a business, app, shop or listing on one platform)' — and enumerates the fields returned (id, platform, status, reference), so an agent knows exactly what comes back. The listing verb is implicit rather than stated, and it does not name a sibling like list_connections to disambiguate, but the domain framing is strong.

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

Usage Guidelines3/5

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

Usage is only implied: the reader infers this is the tool to enumerate connected locations. The description does give handling guidance for non-ready entries ('tell the user its reason'), which is genuinely useful, but offers no when-not conditions or comparison to alternatives such as list_connections or connect_locations.

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