Skip to main content
Glama

list_auxiliary_data

List auxiliary reference data such as localities, branches, users, warehouses, categories, payment methods, and ticket metadata for lookups and validation. Report failures rather than fabricating data.

Instructions

List auxiliary/reference data: localities, branches, users, warehouses, categories, payment methods, ticket metadata, and more. ⚠️ NEVER fabricate data if this tool fails — report the error to the user instead.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
resourceYesType of auxiliary data to list
include_deletedNonodes/subnodes/vlans/svlans only: true = deleted records, false = active records, omitted = API default

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changedv0.4.0
    • addedInput schema / properties / include_deleted
      Added value: +{
      +  "description": "nodes/subnodes/vlans/svlans only: true = deleted records, false = active records, omitted = API default",
      +  "type": "boolean"
      +}
    • changedInput schema / properties / resource / enum
      Previous value: -[
      -  "localities",
      -  "branches",
      -  "users",
      -  "warehouses",
      -  "client_categories",
      -  "additionals",
      -  "payment_methods",
      -  "nodes",
      -  "ticket_categories",
      -  "ticket_subcategories",
      -  "ticket_statuses",
      -  "extra_connection_categories",
      -  "how_did_you_find_us",
      -  "previous_providers",
      -  "service_cancellation_categories"
      -]New value: +[
      +  "localities",
      +  "branches",
      +  "users",
      +  "warehouses",
      +  "client_categories",
      +  "additionals",
      +  "payment_methods",
      +  "nodes",
      +  "subnodes",
      +  "vlans",
      +  "svlans",
      +  "ticket_categories",
      +  "ticket_subcategories",
      +  "ticket_statuses",
      +  "extra_connection_categories",
      +  "how_did_you_find_us",
      +  "previous_providers",
      +  "service_cancellation_categories",
      +  "supplier_tax_categories"
      +]
  2. First observedv0.3.1

TDQS

B3.4/5.0
Behavior3/5

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

With no annotations, the description carries the behavioral burden. The 'NEVER fabricate data if this tool fails' warning is a meaningful guardrail that goes beyond the tool's name, but the description still omits explicit read-only status, output shape, pagination, and include_deleted default behavior.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is two short sentences with no fluff. The purpose is front-loaded and the warning sentence is concise, actionable, and non-redundant.

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 simple single-resource list tool, the schema fully documents all parameters and the description adds a useful safety directive. A brief note about the return shape would improve completeness, but the absence does not critically harm correct invocation.

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%, with the resource enum and include_deleted semantics fully documented. The description adds no additional parameter-level detail (just 'and more'), so the baseline of 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 opens with a specific verb and resource ('List auxiliary/reference data') and gives concrete examples (localities, branches, users, warehouses, payment methods) that distinguish it from subscription, ticket, and invoice siblings. It falls short of 5 because 'and more' is vague and the full scope is only recoverable from the schema enum.

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

Usage Guidelines2/5

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

There is no guidance on when to choose this tool versus sibling tools like list_tickets, list_subscriptions, or get_client. The anti-fabrication warning concerns error handling, not selection criteria, so when-to-use reasoning is left entirely to inference.

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