Skip to main content
Glama

Bsale MCP by usefulapi

Record payment

bsale_create_payment

WRITE: record a payment against an issued document (normally a credit sale that is still unpaid). It changes the document's receivable balance in the books and cannot be removed through this API. Check the amount with bsale_client_unpaid_documents first and get payment_type_id from bsale_list_payment_types. POST /v1/payments.json.

Input Schema

NameRequiredDescriptionDefault
amountYes
paid_onNoPayment date (default: today, UTC).
document_idYes
payment_type_idYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.4/5.0
Behavior4/5

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

Adds real context beyond the annotations: the call changes the document's receivable balance in the books and cannot be undone through this API — a critical irreversibility warning that destructiveHint=false alone would not convey. It stops short of describing validation failures or what the response contains, so it is not fully complete.

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?

Four short sentences, all load-bearing: operation type first, then irreversibility, then prerequisites, then endpoint. No filler.

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?

For a 4-parameter mutation with no output schema, the description covers the operation, its side effect, its permanence, and its prerequisites. It omits what the API returns on success and any amount-validation behavior, which would be helpful but are not blocking.

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?

With only 25% schema description coverage, the description must compensate, and it partially does: it explains that amount should be verified against unpaid documents and where payment_type_id comes from. document_id is only implied by 'against an issued document', and constraints (amount > 0, paid_on defaulting to today) are left to the schema, so compensation is only partial.

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?

Opens with a specific verb and resource ('record a payment against an issued document') plus the typical scenario (normally a credit sale still unpaid), and the 'WRITE:' prefix distinguishes it immediately from the read/list siblings such as bsale_list_payments.

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

Usage Guidelines5/5

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

Explicitly names two prerequisite calls and when to make them: check the amount with bsale_client_unpaid_documents and obtain payment_type_id from bsale_list_payment_types. This is exactly the routing information an agent needs before invoking.

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.