Skip to main content
Glama

settle

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
methodYesSettlement method
period_endNoPeriod end (ISO 8601)
media_buy_idNoSettle specific media buy
period_startNoPeriod start (ISO 8601)
publisher_idNoSettle all for a publisher

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A4.6/5.0
Behavior4/5

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

Annotations already indicate a non-readonly, non-destructive operation. Description adds behavioral context: Stripe/x402 are only stubs, and it describes the output structure (gross, fees, net) despite no output schema. No contradictions with annotations.

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?

Well-structured with four short sections. The main description is a single sentence. No filler; the stub warning appears twice but is acceptable for emphasis.

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?

Given the tool has no output schema, the description compensates with an output_format section. It also covers use cases and parameter guidance. However, it stops short of explaining edge cases like what happens when no pending payments exist or whether settlement is a one-time irreversible action (though annotations hint at idempotency=false).

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

Parameters4/5

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

Schema covers all five parameters with descriptions (100% coverage). Description adds value by explicitly stating method='manual' works for CSV and Stripe/x402 are stubs, clarifying the enum semantics. Combination hints reinforce filter usage but don't add syntax beyond schema.

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?

The description immediately states 'Settle pending payments for media buys,' which uses a specific verb and resource. It further differentiates from sibling tools by listing settlement methods, clearly positioning it as post-campaign revenue collection rather than creation or reporting.

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

Usage Guidelines5/5

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

Provides explicit when-to-use scenarios ('publisher wants to collect earned revenue' / 'advertiser needs to settle outstanding charges') and method-specific guidance ('Use method='manual' for CSV export'). It also warns that Stripe and x402 are stubs, effectively telling the agent not to use them yet. Suggests a combination with get_campaign_report.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.