Skip to main content
Glama

supplier payout

supplier_payout
Destructive

Read supplier payout balances, request payout, or set the agent payout address. read: GET /v1/agents/me/capability-payouts. request: POST /v1/agents/me/capability-payouts; body: optional payout_id. address: POST /v1/agents/me/payout-address; body: payout_address.

Input Schema

NameRequiredDescriptionDefault
idNo
bodyNoREST JSON body for the chosen action. See its documented fields in the action description and OpenAPI.
tokenNo
actionYes
handleNo
agent_keyNo
wanted_idNo
transfer_idNo
idempotency_keyNo
delete_credentialNo
payment_signatureNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changed
    • addedInput schema / description
      Added value: +"Required by action: read: agent_key; request: agent_key; address: agent_key and body."
    • removedInput schema / oneOf
      Removed value: -[
      -  {
      -    "properties": {
      -      "action": {
      -        "const": "read"
      -      }
      -    },
      -    "required": [
      -      "action",
      -      "agent_key"
      -    ]
      -  },
      -  {
      -    "properties": {
      -      "action": {
      -        "const": "request"
      -      }
      -    },
      -    "required": [
      -      "action",
      -      "agent_key"
      -    ]
      -  },
      -  {
      -    "properties": {
      -      "action": {
      -        "const": "address"
      -      }
      -    },
      -    "required": [
      -      "action",
      -      "agent_key",
      -      "body"
      -    ]
      -  }
      -]
  2. Added

TDQS

C2.9/5.0
Behavior2/5

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

Annotations declare destructiveHint=true, readOnlyHint=false, idempotentHint=false, and openWorldHint=true, so the description should explain the consequences of 'request' (moving funds) and how to avoid double payouts. Instead it only lists HTTP routes; despite idempotentHint=false, it never mentions the idempotency_key parameter present in the schema.

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

Conciseness4/5

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

A single telegraphic sentence that front-loads the three actions and then maps each to its route and body fields; nothing is padded. It is dense and semicolon-heavy but economical for the information it attempts to convey.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For an 11-parameter, destructive, money-moving tool with 9% schema coverage and no output schema, the description is far too thin. It omits required credentials per action, idempotency, error/response expectations, and the semantics of most parameters.

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 only 9% across 11 parameters, so the description must compensate and largely fails. It documents only 'payout_id' and 'payout_address' inside the body for two of three actions and says nothing about agent_key (required for every action), idempotency_key, token, or how the many other parameters relate to specific actions.

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 gives specific verbs and resources for all three actions: read payout balances, request a payout, and set the agent payout address. It is clearly a payout-management tool, though it never names the siblings it differs from (balance_get, agent_earnings_get, supplier_checkout).

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 action enum values map to distinct operations, and 'optional payout_id' hints at a targeted redemption, but there is no explicit guidance on when to use request vs address vs simply reading, nor on prerequisites. Usage is implied by the action names rather than stated.

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.

Resources