Skip to main content
Glama

podyx_subscription_quote

Read-onlyIdempotent

Preview subscription checkout requirements and customer selections, returning missing inputs, consents, and payment-source details without creating bookings, holds, payments, or receipts.

Instructions

Preview current customer subscription selections and checkout requirements POST /api/v2/subscription-purchases/quotes. Read-only POST: incomplete selections return status=incomplete and missing_inputs, with current CMS-configured forms, guest limit, recording seats, invoice fields, rail-specific displayed consent documents and paginated file-transfer choices. No client, booking, hold, payment or receipt is created. Prices, tax, promo eligibility and credits are resolved by Podyx; amounts or provider IDs in input are refused. A fingerprint identifies advisory facts, never a price lock or permission to charge. Complete means required selections, details, invoice fields and consent acceptance are supplied; later commands must revalidate. client_id means a currently owned studio Client, requires clients:read in addition to the family read permission, and is never visitor login. Omit it for anonymous preview; email is not accepted here. Existing public_api/account/current-key authority remains required, including after reads. Disabling headless new entry preserves authorized quote reads. Booking sessions are explicit and multi-session; Studio Tour has its own published quote and booking operations. Subscription quotes additionally accept payment_source=native|external, default native: external previews studio collection independently of native provider cadence restrictions; actual studio approval still applies and no collection is reported. Other quote families do not accept payment_source. Bundle/subscription never ask for refund policy; tour consent remains terms only. page/per_page page file-transfer choices only, using the existing 1..100 bounds. Read/preview only. Follow all pagination; a quote does not reserve a slot or lock a price.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "body": "<body>"
    },
    "name": "podyx_subscription_quote"
  }
}

Input Schema

NameRequiredDescriptionDefault
bodyYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.4.0

TDQS

A4.2/5.0
Behavior5/5

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

With readOnlyHint/idempotentHint already given, the description still adds substantial context: no client, booking, hold, payment or receipt is created, incomplete selections return status=incomplete with missing_inputs, server-side pricing refuses client-supplied amounts or provider IDs, and the fingerprint is advisory rather than a price lock. Permission requirements (clients:read plus family read, public_api/account authority) and revalidation obligations are also disclosed.

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

Conciseness3/5

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

Purpose and read-only nature are front-loaded and every clause is factually relevant, but the body is a dense run-on that repeats the no-reservation/no-price-lock point three times ('never a price lock', 'no collection is reported', 'a quote does not reserve a slot or lock a price'). It would scan better as separated sentences or grouped bullets.

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 nested-object quote tool with no output schema, it adequately describes what comes back (incomplete status, missing_inputs, CMS forms, guest limit, seats, consent documents, paginated choices) and the pagination obligation. Minor gaps remain in how the advisory fingerprint is consumed downstream, but nothing critical to calling it correctly 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 0%, so the description carries the burden and does explain client_id (owned studio Client, never visitor login), payment_source semantics, that email is rejected, and that page/per_page apply only to file-transfer choices. However, several parameters (promo_code, duration_id, credit_choice, subscription_plan_id, invoice_profile.type) get no meaning beyond their names, leaving real gaps at 0% coverage.

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?

States a specific verb and resource ('Preview current customer subscription selections and checkout requirements') and pins the endpoint POST /api/v2/subscription-purchases/quotes. It actively distinguishes itself from adjacent quote families (tour, bundle, other quote families) so an agent can route without opening schemas.

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

Usage Guidelines4/5

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

Gives concrete when-to guidance: omit client_id for anonymous preview, Studio Tour has its own published quote and booking operations, and only subscription quotes accept payment_source. It stops short of naming the closest ambiguous sibling (podyx_packages_subscription_quote) or stating an explicit exclusion rule against it.

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