Skip to main content
Glama

Record a deposit received

deposit_record

Record a security or retainer deposit received from a client, in minor units, with its currency, the date it arrived and the bank reference. Returns the DEP-YYYY-NNNN id.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
kindYessecurity: held against damage or non-payment. retainer: held against work not yet invoiced
notesNoFree text kept on the record and printed on the statement
clientYesClient name or client id. A name the invoice server already knows brings its address, email and VAT id onto the deposit
currencyNoDefaults to your business default currency
referenceNoBank reference, transfer note or cheque number the money arrived with
amount_minorYesWhat was received, in MINOR units: 50000 = 500.00 EUR, 50000 = JPY 50000. Never a decimal
client_emailNoOnly if the user gave it; otherwise the stored client's email is used
client_vat_idNoClient VAT / tax registration id
received_dateNoYYYY-MM-DD, the day the money arrived. Defaults to today
client_addressNoPostal address for the statement's client block, newlines allowed

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.6/5.0
Behavior3/5

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

Annotations already signal that this is a mutating, non-read-only action and that it is not idempotent. The description adds the useful fact that it returns a DEP-YYYY-NNNN id, but it does not disclose downstream effects such as how the deposit affects balances or statements. There is no contradiction with the annotations.

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?

The description is two short sentences with no filler. It front-loads the core action and then immediately gives the most important return detail, the DEP-YYYY-NNNN id. Every clause earns its place.

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 a fully self-describing 10-parameter schema, annotations for mutating behavior, and no output schema, the description covers the essential outcome and return ID. It is slightly thin on downstream effects and selection guidance, but for creating a record it is largely complete.

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 100%, so the schema carries the full burden of documenting the 10 parameters. The description adds high-level context by naming minor units, currency, arrival date, and bank reference, but it does not add parameter-specific meaning beyond what the schema already provides.

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 description states a precise verb ('Record') and resource ('security or retainer deposit received from a client'), enumerates the key fields (minor units, currency, date, bank reference), and mentions the resulting DEP-YYYY-NNNN id. This clearly distinguishes it from siblings like deposit_apply, deposit_refund, and deposit_list.

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

Usage Guidelines2/5

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

The description does not explicitly say when to use this tool versus alternatives such as deposit_apply, deposit_refund, or deposit_list. The only implied context is that it is for recording a newly received deposit, which is not enough guidance to prevent an agent from confusing it with related deposit operations.

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.