Skip to main content
Glama

settlement

settlement
Destructive

Create, read, veto, refund, or convert a bilateral settlement to an open rework bounty. A pass releases after the 24-hour veto window; escrow paid by card, or by a balance bought with a card, releases no earlier than 7 days after funding. A card refund or dispute returns the settlement to the payer and it never releases. The owner cannot be paid as its own counterparty. list: GET /v1/settlements. create: POST /v1/settlements; body: amount_usd, deadline_days; exactly one of criteria, template_id, contract_ref; optional counterparty_label, funding_rail. Also send idempotency_key (top level, 8 to 128 letters, digits, or . _ : -); it is sent as the Idempotency-Key header. read: GET /v1/settlements/{id}. veto: POST /v1/settlements/{id}/veto; body: reason. refund: POST /v1/settlements/{id}/refund. counterparty_read: GET /v1/settlements/counterparty/{token}. submit: POST /v1/settlements/counterparty/{token}; body: filename, content, payout_address (or send agent_key for an agent with a payout address); optional mime, encoding (utf8 or base64). The address sent with the passing file is the one paid. flip: POST /v1/settlements/{id}/flip.

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: list: agent_key; create: agent_key, body and idempotency_key; read: id and agent_key; veto: id, agent_key and body; refund: id and agent_key; counterparty_read: token; submit: token and body; flip: id and agent_key."
    • removedInput schema / oneOf
      Removed value: -[
      -  {
      -    "properties": {
      -      "action": {
      -        "const": "list"
      -      }
      -    },
      -    "required": [
      -      "action",
      -      "agent_key"
      -    ]
      -  },
      -  {
      -    "properties": {
      -      "action": {
      -        "const": "create"
      -      }
      -    },
      -    "required": [
      -      "action",
      -      "agent_key",
      -      "body",
      -      "idempotency_key"
      -    ]
      -  },
      -  {
      -    "properties": {
      -      "action": {
      -        "const": "read"
      -      }
      -    },
      -    "required": [
      -      "action",
      -      "id",
      -      "agent_key"
      -    ]
      -  },
      -  {
      -    "properties": {
      -      "action": {
      -        "const": "veto"
      -      }
      -    },
      -    "required": [
      -      "action",
      -      "id",
      -      "agent_key",
      -      "body"
      -    ]
      -  },
      -  {
      -    "properties": {
      -      "action": {
      -        "const": "refund"
      -      }
      -    },
      -    "required": [
      -      "action",
      -      "id",
      -      "agent_key"
      -    ]
      -  },
      -  {
      -    "properties": {
      -      "action": {
      -        "const": "counterparty_read"
      -      }
      -    },
      -    "required": [
      -      "action",
      -      "token"
      -    ]
      -  },
      -  {
      -    "properties": {
      -      "action": {
      -        "const": "submit"
      -      }
      -    },
      -    "required": [
      -      "action",
      -      "token",
      -      "body"
      -    ]
      -  },
      -  {
      -    "properties": {
      -      "action": {
      -        "const": "flip"
      -      }
      -    },
      -    "required": [
      -      "action",
      -      "id",
      -      "agent_key"
      -    ]
      -  }
      -]
  2. Changed1 schema field changed
    • changedInput schema / oneOf
      Previous value: -[
      -  {
      -    "properties": {
      -      "action": {
      -        "const": "list"
      -      }
      -    },
      -    "required": [
      -      "action",
      -      "agent_key"
      -    ]
      -  },
      -  {
      -    "properties": {
      -      "action": {
      -        "const": "create"
      -      }
      -    },
      -    "required": [
      -      "action",
      -      "agent_key",
      -      "body"
      -    ]
      -  },
      -  {
      -    "properties": {
      -      "action": {
      -        "const": "read"
      -      }
      -    },
      -    "required": [
      -      "action",
      -      "id",
      -      "agent_key"
      -    ]
      -  },
      -  {
      -    "properties": {
      -      "action": {
      -        "const": "veto"
      -      }
      -    },
      -    "required": [
      -      "action",
      -      "id",
      -      "agent_key",
      -      "body"
      -    ]
      -  },
      -  {
      -    "properties": {
      -      "action": {
      -        "const": "refund"
      -      }
      -    },
      -    "required": [
      -      "action",
      -      "id",
      -      "agent_key"
      -    ]
      -  },
      -  {
      -    "properties": {
      -      "action": {
      -        "const": "counterparty_read"
      -      }
      -    },
      -    "required": [
      -      "action",
      -      "token"
      -    ]
      -  },
      -  {
      -    "properties": {
      -      "action": {
      -        "const": "submit"
      -      }
      -    },
      -    "required": [
      -      "action",
      -      "token",
      -      "body"
      -    ]
      -  },
      -  {
      -    "properties": {
      -      "action": {
      -        "const": "flip"
      -      }
      -    },
      -    "required": [
      -      "action",
      -      "id",
      -      "agent_key"
      -    ]
      -  }
      -]New value: +[
      +  {
      +    "properties": {
      +      "action": {
      +        "const": "list"
      +      }
      +    },
      +    "required": [
      +      "action",
      +      "agent_key"
      +    ]
      +  },
      +  {
      +    "properties": {
      +      "action": {
      +        "const": "create"
      +      }
      +    },
      +    "required": [
      +      "action",
      +      "agent_key",
      +      "body",
      +      "idempotency_key"
      +    ]
      +  },
      +  {
      +    "properties": {
      +      "action": {
      +        "const": "read"
      +      }
      +    },
      +    "required": [
      +      "action",
      +      "id",
      +      "agent_key"
      +    ]
      +  },
      +  {
      +    "properties": {
      +      "action": {
      +        "const": "veto"
      +      }
      +    },
      +    "required": [
      +      "action",
      +      "id",
      +      "agent_key",
      +      "body"
      +    ]
      +  },
      +  {
      +    "properties": {
      +      "action": {
      +        "const": "refund"
      +      }
      +    },
      +    "required": [
      +      "action",
      +      "id",
      +      "agent_key"
      +    ]
      +  },
      +  {
      +    "properties": {
      +      "action": {
      +        "const": "counterparty_read"
      +      }
      +    },
      +    "required": [
      +      "action",
      +      "token"
      +    ]
      +  },
      +  {
      +    "properties": {
      +      "action": {
      +        "const": "submit"
      +      }
      +    },
      +    "required": [
      +      "action",
      +      "token",
      +      "body"
      +    ]
      +  },
      +  {
      +    "properties": {
      +      "action": {
      +        "const": "flip"
      +      }
      +    },
      +    "required": [
      +      "action",
      +      "id",
      +      "agent_key"
      +    ]
      +  }
      +]
  3. Added

TDQS

A3.6/5.0
Behavior4/5

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

Annotations already flag destructiveHint=true and openWorldHint=true, yet the description still adds substantive context: the 24-hour veto window, the 7-day escrow release floor, the fact that a refund or dispute permanently prevents release, and that the owner cannot be its own counterparty. It does not cover auth prerequisites (agent_key) or rate/idempotency-replay behavior in prose, which keeps it short of a 5.

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?

Lifecycle constraints are front-loaded before the per-action endpoint list, which is the right order for an agent deciding whether to act. It is long and densely run-on, but for an eight-action tool nearly every sentence carries a fact that is not in the schema.

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?

For an eight-action, eleven-parameter tool with no output schema, the description covers most action semantics well but leaves the undocumented parameters and any return-shape information (pagination for list, response body for create) unaddressed. An agent can call the common paths correctly but will be guessing on the remainder.

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 only 9%, so the description has to carry weight, and it does document body fields per action, the idempotency_key format and header mapping, and how token/id/agent_key are used. However, five parameters (handle, wanted_id, transfer_id, delete_credential, payment_signature) are never mentioned anywhere, leaving an agent with no guidance for nearly half the surface.

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 opening sentence enumerates the concrete operations (create, read, veto, refund, flip) and the resource (bilateral settlement), then maps each action to its REST endpoint. The purpose is clear, but nothing distinguishes this tool from adjacent siblings like bounty_fund, payment_status, or supplier_payout, so an agent must infer which workflow belongs here.

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?

Usage is implied through the lifecycle rules: a pass releases after the 24-hour veto window, card-funded escrow releases no earlier than 7 days, a refund returns funds to the payer. These help an agent reason about which action to pick, but there is no explicit 'use this when'/'do not use when' or a named alternative tool for the overlapping money-movement cases.

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