Skip to main content
Glama
WYRE-AI
by WYRE-AI

sherweb_billing_payable_charges

Retrieve distributor payable charges for any billing period, including recurring, usage, and setup charges with pricing, taxes, and invoice details.

Instructions

Get the distributor payable charges for a billing period. Returns every charge in the period — recurring, usage and setup — with pricing, deductions, fees, taxes and invoice details.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
dateNoAny date inside the desired billing period, format yyyy-MM-dd (UTC). Defaults to today. E.g. 2026-03-17 returns the period containing March 17.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed6 schema fields changedv2.0.0
    • removedInput schema / properties / billingCycleType
      Removed value: -{
      -  "description": "The billing cycle type to filter by (OneTime, Monthly, or Yearly)",
      -  "enum": [
      -    "OneTime",
      -    "Monthly",
      -    "Yearly"
      -  ],
      -  "type": "string"
      -}
    • addedInput schema / properties / date
      Added value: +{
      +  "description": "Any date inside the desired billing period, format yyyy-MM-dd (UTC). Defaults to today. E.g. 2026-03-17 returns the period containing March 17.",
      +  "type": "string"
      +}
    • removedInput schema / properties / page
      Removed value: -{
      -  "description": "Page number for pagination (default: 1)",
      -  "type": "number"
      -}
    • removedInput schema / properties / pageSize
      Removed value: -{
      -  "description": "Number of items per page (default: 50)",
      -  "type": "number"
      -}
    • removedInput schema / properties / periodFrom
      Removed value: -{
      -  "description": "Start date of the billing period (ISO 8601 format, e.g., 2025-01-01)",
      -  "type": "string"
      -}
    • removedInput schema / properties / periodTo
      Removed value: -{
      -  "description": "End date of the billing period (ISO 8601 format, e.g., 2025-01-31)",
      -  "type": "string"
      -}
  2. First observedv0.0.0-semantically-released

TDQS

A3.8/5.0
Behavior4/5

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

With no annotations, the description carries the full behavioral disclosure burden. It clearly signals a read-only listing action ('Get ... Returns every charge') and enumerates the returned data categories (pricing, deductions, fees, taxes, invoice details). It does not mention pagination or auth requirements, but the tool is a simple read operation.

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 sentences, front-loaded with the primary action, and every clause adds useful detail about what is returned. There is no repetition or filler.

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 one-optional-parameter read tool, the description covers period selection and return contents comprehensively. It could be slightly more complete by naming the related charge-details sibling, but nothing needed to invoke the tool 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 100%: the date parameter already includes format, UTC default, and an example. The tool description adds nothing beyond 'billing period', so it correctly relies on the schema rather than compensating for missing parameter documentation.

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 uses a specific verb and resource ('Get the distributor payable charges') and clarifies the scope ('every charge in the period — recurring, usage and setup'), which separates it from the sibling billing charge-details tool. It does not explicitly name an alternative, so it stops short of the strongest possible sibling differentiation.

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 description implies the usage context: querying distributor payable charges for a billing period. However, it gives no explicit when-to-use versus when-not-to-use guidance relative to siblings such as sherweb_billing_charge_details or accounts receivable.

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