Skip to main content
Glama

Record that you were paid in a VSH ecocredit (step 1 of 2)

prepare_credit_settlement
Read-onlyIdempotent

After your proof is approved and someone sent you VSH ecocredits on Regen Ledger: name the batch denom and the regen-1 transaction hash, and the board reads the transfer that reached the regen1 account YOUR signing key controls, then writes the same settlement record a dollar payout writes. Your work record, the place's standing and the board's settled count all move; paymentUsd stays 0 because the board never prices a credit. Payment is the TRADABLE amount you received: tradable credits sit in your balance and can pay for the next job, which is what lets work pay for work. Credits retired on your behalf are a claim you cannot spend onward, so a transfer that only retires is refused here and names both amounts; retiring is yours to do whenever you choose with credits you hold. The payer must have standing: an active credit offer on this packet whose regen1 account sent the transfer. FREE, no gas. Returns MESSAGE_TO_SIGN and BODY_JSON; sign with the worker wallet's personal_sign, then call submit_credit_settlement within 5 minutes. Cost and signer: free, no gas; the person signs the result with their own wallet or passkey, and the house never holds a key.

Input Schema

NameRequiredDescriptionDefault
txHashYesThe 64-character hex hash of the regen-1 transaction that paid you (no 0x prefix).
workIdYesThe packet you proved.
batchDenomYesThe Regen credit batch denom you were paid in, e.g. VSH01-001-20260907-20270907-001.
workerWalletYesThe 0x… address on the approved proof, the wallet that was paid and will sign.

Output Schema

NameRequiredDescriptionDefault
okNo
toolNo
fundedNo
payUsdNo
workIdNo
claimIdNo
claimableNo
next_callNo
proofRuleNo
fulfillableByNo
definitionOfDoneNo
needs_from_callerNo
notClaimableReasonNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A3.8/5.0
Behavior2/5

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

Rich disclosure of cost ('FREE, no gas'), signer model (worker wallet personal_sign or passkey, house never holds a key), payer standing requirement (active credit offer on the packet), and the 5-minute signature TTL. However, it states this call 'writes the same settlement record' and that 'your work record, the place's standing and the board's settled count all move' — a state mutation attributed to this invoke — while annotations declare readOnlyHint=true and idempotentHint=true. The write actually belongs to submit_credit_settlement, so the description misleads about when state changes.

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

Conciseness3/5

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

The action and the inputs are front-loaded, which is good, but the body wanders into motivation ('what lets work pay for work') and repeats the cost/signer information twice ('FREE, no gas' mid-paragraph and again as 'Cost and signer: free, no gas'). Roughly a quarter of the text could be cut without losing instructions.

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 an output schema exists, return values need not be detailed, and the description still flags MESSAGE_TO_SIGN/BODY_JSON and the signing step. It covers prerequisites, cost, signer, refusal cases and the next call; the main gap is that the two-step commit semantics are described inconsistently, leaving the agent unsure whether the settlement is final at prepare time or at submit time.

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 coverage is 100%, so the baseline is 3, but the description adds real constraint beyond the schema: the txHash must be a transfer that reached the regen1 account controlled by the signing key, and the amount credited must be tradable rather than retired. That materially narrows which values are valid, though it doesn't spell out the relationship between workerWallet and worker identity beyond 'YOUR signing key controls'.

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?

Names a specific verb and resource ('record that you were paid in a VSH ecocredit'), the exact inputs required (batch denom + regen-1 tx hash), and positions itself as step 1 of 2 with submit_credit_settlement as the follow-up. An agent can distinguish it from submit_credit_settlement and from the dollar-payout path without opening any schema.

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

Usage Guidelines4/5

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

Clear entry condition ('after your proof is approved and someone sent you VSH ecocredits'), an explicit exclusion ('a transfer that only retires is refused here'), and the required follow-up call plus 5-minute window. It does not name the sibling alternatives (prepare_direct_settlement / prepare_token_settlement) outright, so the routing decision between settlement types is only implied.

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