@dfm-fi/agent

Official

by DFM-Finance

Overview Schema Source Related Servers Discussions Admin

TypeScript

Remote

Zap-v2 Escrow Status

zap_status

Read-only

Retrieve decoded zap-v2 escrow status for a vault and user, including mode, leg progress, expiry, and failure reasons. Omit user to inspect the app wallet; returns null if no escrow is open.

Instructions

Get the decoded zap-v2 escrow for a (vault, user) from the live API (GET /vaults/:address/zap-v2/status/:user), or null if none is open. Shows mode (0=deposit,1=redeem), per-leg crank progress (legsFilled/legsTotal), readyToClose, expiry, and per-leg failure reasons. Omit user to inspect assigned app wallet, including its existing escrows after revoke. A configured external keypair does not change escrow ownership. AUTH never permits an unrelated wallet.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "vault": "<vault>"
    },
    "name": "zap_status"
  }
}

Input Schema

Name	Required	Description	Default
`user`	No
`vault`	Yes

Schema Changelog

Changes observed during successful MCP inspections.

First observedv0.2.1967Oct 20, 2026

TDQS

A4.3/5.0

Behavior4/5

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

Annotations already declare readOnlyHint and openWorldHint, so the safety profile is covered, and the description adds real context: null when nothing is open, what fields are shown (mode, crank progress, readyToClose, expiry, failure reasons), and explicit auth/ownership behavior ('external keypair does not change escrow ownership', 'AUTH never permits an unrelated wallet').

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?

Front-loaded with verb, resource and route, then value details, then edge-case/auth notes. Dense with little waste, though the two trailing auth sentences add length that only marginally aids invocation.

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 compensates by enumerating the returned fields and the null case, plus auth constraints. It is sufficiently complete for a read-only status tool, leaving only minor gaps like pagination (not applicable) or error behavior.

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 0%, so the description must carry param meaning, and it does explain the optional `user` parameter's semantics (omit to inspect the app wallet) beyond the schema merely marking it non-required. `vault` is only implied via the route, keeping it short of a perfect 5.

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?

Specific verb (Get) plus resource (decoded zap-v2 escrow) plus scope (vault, user), with the concrete API route. An agent can distinguish it from zap_v2_cancel and zap_v2_update_envelope without inspecting schemas.

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?

Gives clear context for the primary call and a notable usage variant (omit `user` to inspect the assigned app wallet, including existing escrows after revoke). It does not name alternative tools or explicitly state when-not-to-use, but the usage is unambiguous for this read operation.

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