Skip to main content
Glama

podyx_v1_reports_revenue

Read-onlyIdempotent

Analyze studio revenue reports by date range, recognition metric, currency, and client, room, or service filters; review paginated contribution breakdowns for business performance monitoring.

Instructions

Analyze studio revenue GET /api/v1/reports/revenue. Requires current reports:read. Customer identities and signed client filters require clients:read. Evidence rechecks all resource permissions. Typed input, complexity and recorded allocation coverage errors are 422 with no partial headline; invalid or inaccessible references are opaque 404. Busy analysis capacity returns 429 analysis_busy with Retry-After: 1 and no partial headline. Ordinary infrastructure faults retain the native 500/503 contracts. 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_v1_reports_revenue"
  }
}

Input Schema

NameRequiredDescriptionDefault
queryNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.4.0

TDQS

A3.5/5.0
Behavior5/5

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

Annotations already cover the read-only/idempotent/non-destructive profile, yet the description goes well beyond them: permission rechecks on every resource, 422 for typed input/complexity/allocation-coverage errors with no partial headline, opaque 404 for inaccessible references, 429 analysis_busy with Retry-After: 1, and native 500/503 for infrastructure faults. That is exactly the failure-mode and capacity context an agent needs before calling.

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?

The purpose and permission requirements are front-loaded, which is good, but the middle is a dense run-on of status-code contracts that is hard to parse. The closing sentence 'a quote does not reserve a slot or lock a price' is boilerplate carried over from quote tools and is irrelevant to a read-only revenue report, costing credibility on an otherwise tight definition.

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?

Auth, failure modes, pagination and read-only status are covered, and no output schema exists so return values need not be explained. But for a heavily parameterized report with a nested query object, the definition leaves the agent without guidance on its main decision surface (metrics, presets, grouping, comparison windows) and without any sibling differentiation.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters2/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is reported at 0% (the single top-level 'query' object is undocumented), so the description is responsible for explaining the parameter surface and it contributes nothing. None of the meaningful controls – metric, preset, group_by, date bounds, currency, client/plan/room/service filters, page/page_size – are mentioned; only the generic instruction to 'follow all pagination' appears.

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 states a concrete verb and resource ('Analyze studio revenue') and pins it to the endpoint GET /api/v1/reports/revenue, so the agent knows this is a revenue reporting read. It stops short of distinguishing it from near-identical siblings such as podyx_v1_reports_summary, podyx_v1_reports_metrics and podyx_v1_reports_customers, all of which could plausibly be described the same way.

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?

Useful prerequisites are given: current reports:read is required, and clients:read is needed for customer identities and signed client filters. However, there is no when-to-use guidance versus the other reports_* siblings, and no statement of when a caller should pick this over summary or metrics.

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