Skip to main content
Glama

podyx_list_addon

Read-onlyIdempotent

Lists catalog addons with pagination and filters for view mode, room, setup, service, active status, and configured price pages, enabling read-only review of authoring drafts or offer buyability.

Instructions

List catalog addons GET /api/v2/addons. Catalog owns JSON normalization, versioning, links, configured prices and lifecycle. Authoring includes drafts; view=offers reuses customer buyability. Configured prices are independently paginated with prices_page/prices_per_page and refer to current service versions. Amounts are configured catalog rates, not a dated customer quote. Omitted links/override sections preserve; [] clears the submitted collection. Archive deactivates; restore reactivates and enforces existing room allowances. Mutations require a UUID Idempotency-Key and current primary/linked-resource authority, including receipt replay. Read/preview only. Follow all pagination; a quote does not reserve a slot or lock a price.

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": "podyx_list_addon"
  }
}

Input Schema

NameRequiredDescriptionDefault
queryNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.4.0

TDQS

B3/5.0
Behavior2/5

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

Annotations already declare readOnlyHint, idempotentHint and destructiveHint=false, so the safety profile is covered. The description adds some useful behavior (configured prices paginate independently, amounts are catalog rates rather than a dated quote, a quote does not reserve a slot), but it is dominated by write-path boilerplate that is irrelevant here: "Mutations require a UUID Idempotency-Key", "[] clears the submitted collection", "Archive deactivates; restore reactivates". That content is copy-paste from a broader addon API doc and misleads an agent about what this read-only listing can do.

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

Conciseness2/5

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

The description is a dense run-on of semicolon-joined API-doc fragments rather than a front-loaded summary. Several sentences (idempotency keys, archive/restore, override clearing) earn no place in a read-only list tool and push the genuinely relevant pagination and view guidance into the middle.

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?

For a tool with a nested query object of ten undocumented properties and no output schema, the description should at minimum explain what is returned and what each filter does. It covers pagination expectations and price semantics but never describes the returned addon shape or the purpose of the id-based filters, leaving the agent guessing on both ends.

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 0%, so the description carries the full burden. It does explain the most ambiguous pieces — view=authoring vs view=offers and the separate prices_page/prices_per_page pagination — which the schema does not. However, the filter parameters (room_id, setup_id, service_id, include_inactive) and page/per_page are never explained, so roughly half the nested schema remains opaque.

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 opening sentence gives a clear verb and resource ("List catalog addons") plus the underlying endpoint GET /api/v2/addons, so an agent knows exactly what this returns. It does not, however, distinguish itself from the close sibling podyx_v1_list_addons or from podyx_get_addon, leaving the v2-vs-v1 choice to inference.

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?

"Authoring includes drafts; view=offers reuses customer buyability" and "Read/preview only" imply when this listing is appropriate and what the view switch means. There is no explicit statement of when to prefer this over podyx_v1_list_addons, podyx_get_addon, or the quote tools, and no exclusions or prerequisites are given.

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