Skip to main content
Glama

List areas

deputy_list_areas
Read-only

List areas (Deputy OperationalUnits — the rosterable sections of a location, e.g. Kitchen, Front of house). Shifts and timesheets belong to an area. Optionally only one location's areas. Deputy: GET /api/v1/resource/OperationalUnit, or POST .../OperationalUnit/QUERY when filtered.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
maxNoPage size, 1-500 (Deputy's cap). Default 100.
startNoPagination offset (0-based). Pass the previous page's next_start.
activeNoOnly active (true) or inactive (false) areas.
location_idNoOnly areas of this location (Company id).

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • changedInput schema / $schema
      Previous value: -"http://json-schema.org/draft-07/schema#"New value: +"https://json-schema.org/draft/2020-12/schema"
  2. First observed

TDQS

A3.8/5.0
Behavior3/5

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

readOnlyHint=true already tells the agent this is a safe read, so the description is not carrying the safety burden. It adds useful domain context that shifts and timesheets belong to an area, but does not disclose pagination behavior, default limits, or result shape beyond what the annotations and schema imply.

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?

Short and front-loaded: the resource and its meaning come first, then scope and filtering. The trailing endpoint paths (GET/POST .../OperationalUnit) are the one expendable element for an agent-facing definition, but overall there is little waste.

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 no-required-parameter, non-destructive list tool with 100% schema coverage and no output schema, the description supplies everything an agent needs: what an area is, how it relates to shifts/timesheets, and that results can be scoped to one location. Nothing essential is missing.

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 100%, so all four parameters (max, start, active, location_id) are already documented, including the cap and offset semantics. The description only loosely echoes the location filter ('Optionally only one location's areas') and adds no format or edge-case detail beyond the schema; baseline 3 is appropriate.

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?

Uses a specific verb (List) on a specific resource and immediately disambiguates the Deputy term 'OperationalUnit' with the domain gloss 'the rosterable sections of a location, e.g. Kitchen, Front of house'. It also states the relationship to shifts/timesheets and the filtering capability, so an agent can distinguish it from siblings like deputy_list_locations or deputy_query_resource without opening the schema.

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?

'Optionally only one location's areas' implies when the location_id filter applies, but there is no explicit when-to-use/when-not-to-use guidance relative to siblings such as deputy_list_locations or deputy_describe_resource. The mention of the underlying GET vs POST QUERY endpoints is implementation detail, not invocation guidance for the agent.

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.