finance

Debt Payments: Suggest a debt-payment description pattern

suggest_debt_payment_pattern

Read-onlyIdempotent

    Suggest a description pattern for a new debt-payment rule.

    Scans recent withdrawals on the source (asset) account for ones whose
    description contains the debt account's institution name — the same
    helper the web "suggest pattern" button uses. Read-only (suggests, does
    not create a rule). The returned ``pattern`` is in the format
    debt-payment rules accept.

    Args:
        source_account_id: The asset account the payment comes from.
        debt_account_id: The debt account being paid.

    Returns:
        ``{"pattern": str|None, "sample_transactions": [{id, description,
        amount, date}]}`` — ``pattern`` is None when the debt account has no
        institution set or no matching withdrawals were found. Returns
        ``{"error": "..."}`` if either account isn't the caller's.

Input Schema

TableJSON Schema

Name	Required	Description	Default
`debt_account_id`	Yes
`source_account_id`	Yes

Schema Changelog

Changes observed during successful MCP inspections.

First observedSep 22, 2026

TDQS

A4.7/5.0

Behavior5/5

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

Beyond the annotations (readOnlyHint=true, idempotentHint=true, destructiveHint=false), the description discloses the scanning mechanism, that no rule is created, the exact pattern format debt-payment rules accept, that pattern is None when no institution is set or no matches exist, and that an error is returned for non-owned accounts.

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 the core purpose, then structured Args/Returns sections. Every element earns its place, though the Returns block is somewhat verbose — justified here because no output schema exists to carry return-shape information.

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

Completeness5/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 supplies the return contract (pattern plus sample_transactions fields) and both edge cases (None pattern, error on unauthorized accounts). Nothing an agent needs to invoke and interpret the result is missing.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters5/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 0%, so the description carries the full burden. The Args section fully compensates by defining source_account_id as the asset/paying account and debt_account_id as the debt account being paid, which the bare integer schema does not convey.

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?

The first sentence gives a specific verb+resource: 'Suggest a description pattern for a new debt-payment rule.' It distinguishes itself from siblings like create_debt_payment_rule by clarifying it 'suggests, does not create a rule', so an agent can route correctly without opening 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?

It explains the operational context (scans recent withdrawals on the source account for matching institution names, mirroring the web 'suggest pattern' button) and clarifies it is read-only. The implicit alternative is create_debt_payment_rule, but the exclusion is only hinted ('does not create a rule') rather than explicitly naming the sibling.

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

All finance tools Inspect

Try in Browser

One endpoint for every MCP toolRayrun runs every MCP server behind one URL and holds the credentials. Each call is decided per client, tool, and argument, then recorded.ray.runAd

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources

Need Help?