Skip to main content
Glama

vintrace MCP by usefulapi

Vessel contents report

vintrace_get_vessel_details_report
Read-only

The bulk wine report: every vessel (tank, barrel, bin, press, tanker) with its contents, volume, batch, owner and winery as at a date. Use extra_fields=composition,allocations,liveMetrics to add them. Covers every winery the token's user may access unless wineryId/wineryName narrows it. GET /v7/report/vessel-details-report.

Input Schema

NameRequiredDescriptionDefault
as_atNoRun the report as at this time (default now).
batchNoOnly vessels holding this wine batch.
limitNoResults per page, 1-200 (vintrace default 10).
ownerNoOnly this owner.
offsetNoIndex of the first result (default 0). Pass the previous reply's offset + limit.
vesselNoOnly this vessel (by name/code).
vessel_idNoOnly this vessel id.
winery_idNoOnly this winery.
product_idNoOnly this wine/product id.
vessel_typeNoVessel types, comma-separated: TANK, BIN, BARREL, BARREL_GROUP, BIN_GROUP, PRESS, TANKER.
winery_nameNoOnly the winery with this exact name.
extra_fieldsNoExtra fields, comma-separated: composition, allocations, liveMetrics.
business_unitNoOnly this winery business unit.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.3/5.0
Behavior4/5

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

Annotations already carry readOnly/openWorld/destructive, so the description's added value is the authorization scope ('every winery the token's user may access') and the point-in-time snapshot semantics of as_at — both non-obvious and genuinely useful. It does not describe result volume or pagination behaviour, which for an all-wineries report is a real omission.

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?

Three tight sentences, front-loaded with the report's identity before the options. Slight waste in restating the extra_fields enum already in the schema and in trailing the raw HTTP path, but nothing is padded.

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 13 optional parameters, no output schema and no nested objects, the description covers what comes back (per-vessel contents plus owner/winery/batch), the temporal cut, and the access scope. The gaps are pagination expectations and enumerating which filters are mutually useful, but the offset/limit schema descriptions already handle paging.

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 100%, so baseline is 3; the description earns above baseline by explaining what extra_fields actually does (adds sections to the output) and that wineryId/wineryName scope the whole result set rather than being per-row filters. Minor cost: it spells those parameters in camelCase while the schema uses winery_id/winery_name.

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?

States a specific artifact ('The bulk wine report'), enumerates the entities it covers (tank, barrel, bin, press, tanker) and the row fields returned (contents, volume, batch, owner, winery) as at a date. That scope wording also implicitly separates it from the single-entity sibling vintrace_get_vessel and from vintrace_list_inventory.

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?

'Use extra_fields=composition,allocations,liveMetrics to add them' tells the agent how to widen the payload, and the winery-scoping sentence states the default breadth and how to narrow it. No explicit when-not-to-use or sibling hand-off (e.g. versus vintrace_get_vessel for one vessel), so it stops short of a 5.

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.