Skip to main content
Glama

Cin7 Core MCP by usefulapi

Get sale

cin7core_get_sale
Read-only

One sale by id with everything on it: customer, contact, addresses, terms, location, notes, quote, order lines, fulfilments (pick/pack/ship and tracking), invoices, credit notes, payments, attachments and inventory movements. GET /sale?ID=…

Input Schema

NameRequiredDescriptionDefault
sale_idYesSale id (GUID, the SaleID from cin7core_list_sales).
include_transactionsNoInclude the related accounting transactions.
hide_inventory_movementsNoLeave out inventory movements (smaller reply).
combine_additional_chargesNoShow additional charges inside the line arrays.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

B3.2/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, openWorldHint=true and destructiveHint=false, so the safety profile is covered. The description adds useful context by exposing the GET endpoint (idempotent read) and warning that the reply is heavy ('everything on it'), which explains why the smaller-reply flags exist. Auth, rate limits and pagination remain undisclosed.

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?

A single front-loaded sentence; the long item list is dense but each entry informs the agent about the return shape, which matters because there is no output schema. No filler text.

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 correctly carries the burden of describing return content, and it does so thoroughly; parameters are fully documented in the schema and the safety profile in annotations. The one missing piece is routing guidance against cin7core_list_sales.

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%, including the GUID pattern and the origin of sale_id, so the schema already does the heavy lifting. The description adds nothing about include_transactions, hide_inventory_movements or combine_additional_charges, so the baseline 3 applies.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

Specific verb+resource ('One sale by id') with an explicit enumeration of what the record contains, which is enough to separate it from the list_* siblings. It stops short of naming cin7core_list_sales as the alternative, so the differentiation is implicit rather than stated.

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 never states when to use this tool versus cin7core_list_sales or when a single-sale fetch is inappropriate. The only hint ('by id') is embedded in a phrase that mostly describes payload, not usage context.

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.