Skip to main content
Glama

Post Instances Customers Wallets Yield Disable

PostV1InstancesCustomersWalletsYieldDisable

Disables yield for a specified customer wallet, redeeming the vault position back to the wallet and collecting accrued fees; returns the wallet with yield status updated.

Instructions

Turns yield off for the wallet. Returns the wallet, not the yield object. The wallet moves to disabling, the vault position is redeemed back to the wallet and any accrued fee is collected, then yield_status settles to disabled and a wallet.update webhook fires.

Input Schema

NameRequiredDescriptionDefault
idYes
customer_idYesCustomer ID
instance_idYes
Idempotency-KeyNoOptional key to safely retry this request without performing the action twice. Retrying with the same key and an identical body replays the original response; reusing a key with a different body returns an error. Keys are kept for 24 hours.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv1.9.3

TDQS

A3.9/5.0
Behavior4/5

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

Annotations already declare this is a non-read-only, non-destructive, non-idempotent mutation, and the description adds real value on top: the state machine (disabling → redemption → fee collection → disabled), the webhook side effect (wallet.update), and the shape of the response. It stops short of saying whether the call is async and must be polled, or what happens if yield is already disabled.

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?

Two tightly packed sentences with zero filler: purpose first, then return-value caveat, then the transition sequence. Every clause carries information an agent would otherwise have to guess.

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?

With no output schema, the description usefully tells the agent what comes back and what side effects occur, which covers most of what's needed for a mutation. The missing piece is parameter-level guidance and retry semantics, which matter here because idempotentHint is false while an Idempotency-Key header exists.

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 50% — `id` and `instance_id` carry no descriptions, only length/example constraints. The description never mentions any of the four parameters, so it does not compensate for the gap; an agent gets no clarification that `id` is the wallet identifier in the yield-disable path, nor any hint tying Idempotency-Key to safe retries of this non-idempotent call.

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?

States a specific verb and resource: 'Turns yield off for the wallet.' It also distinguishes the return value ('Returns the wallet, not the yield object'), which separates it from the sibling YieldEnable and the GetV1InstancesCustomersWalletsYield read endpoints.

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 only implied by the verb — an agent can infer this is the inverse of PostV1InstancesCustomersWalletsYieldEnable. There is no explicit statement about prerequisites (must yield already be enabled?), no pointer to the Enable sibling as the alternative, and no guidance on when to prefer reading yield status first.

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