Skip to main content
Glama

List reference values

list_reference_values
Read-onlyIdempotent

Fetch AppyWay numeric reference IDs for vehicle, permit, fuel and restriction types, plus countries, regions and payment providers; pass a country or region ID to get one record.

Instructions

AppyWay's reference data: the numeric ids used by the other tools (vehicle_types, permit_types, fuel_types, activity_types, payment_methods, restriction_types, zone_types, ...), plus countries (with public holidays), regions (with event venues) and payment providers. For countries and regions an id fetches one record.

Input Schema

NameRequiredDescriptionDefault
idNoFor countries or regions: fetch this one record
listYesWhich reference list
queryNoCase-insensitive match on name
locale_codeNoFor restriction_types: the IETF BCP 47 locale for names (e.g. en-GB)
max_resultsNo
include_contact_detailsNoReturn telephone numbers of payment providers, car park operators and notes, and stop redacting email addresses and phone numbers from names, notes, tags, addresses and location codes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

B3.4/5.0
Behavior3/5

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

Annotations already declare readOnlyHint, idempotentHint, destructiveHint=false and openWorldHint, so the safety profile is covered by structured data. The description adds domain context (countries carry public holidays, regions carry event venues; single-record retrieval for countries/regions) but says nothing about pagination, rate limits, or the redaction behavior that include_contact_details controls.

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?

Two sentences, front-loaded with what the tool returns, and the trailing clause about id-based single-record fetches is placed where it matters. The parenthetical list of list-names is somewhat long but serves as concrete scope evidence rather than filler.

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

Completeness3/5

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

There is no output schema, so the description carries the burden of describing return shape, and it only gestures at it ('an id fetches one record') without saying whether lists return id/name pairs or full objects. Combined with a 23-value enum and six parameters, the definition is adequate but leaves an agent guessing about response format.

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 83%, so the baseline is 3, and the description largely restates the schema's own id semantics ('an id fetches one record'). It does usefully name several of the list values and clarifies that payment_providers is distinct from payment_methods, but it does not explain query, max_results, or locale_code behavior beyond the schema.

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?

States a specific resource (AppyWay reference data / lookup lists) and explains what the values are for: the numeric ids consumed by other tools. An agent can tell it is a taxonomy lookup rather than a rule/geometry tool. It does not, however, distinguish itself from the sibling list_authorities, which is also a list-style tool.

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?

The phrase 'the numeric ids used by the other tools' implicitly tells the agent to call this to resolve ids before using other endpoints, which is real usage context. There are no explicit when-to-use conditions, no exclusions, and no routing advice relative to list_authorities or get_parking_entity.

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