Skip to main content
Glama

vintrace MCP by usefulapi

Add a note to a stock item

vintrace_add_stock_item_note

WRITE: adds a new note to a vintrace stock item (visible to everyone in the winery, recorded under the token's user). Adding the same note twice creates two notes. POST /v6/mrp/stock/{id}/notes.

Input Schema

NameRequiredDescriptionDefault
detailYesThe note text.
subjectNoOptional subject line.
stock_item_idYesvintrace stock item id.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=false, idempotentHint=false, destructiveHint=false and openWorldHint=true, so the description goes beyond them usefully: it discloses audience visibility ('visible to everyone in the winery'), attribution ('recorded under the token's user'), and concretizes non-idempotency ('Adding the same note twice creates two notes'). It stops short of failure modes or permission prerequisites, so not a 5.

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?

A single front-loaded sentence carrying the operation, audience, attribution and duplicate semantics, followed by the endpoint. No filler or restated title.

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 3-parameter mutation with no output schema, the description covers what the operation does and its side effects, and annotations cover the safety profile. It omits what the API returns on success (e.g. new note id), which would be the remaining useful detail.

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%, with each of stock_item_id, detail and subject documented in the schema, so the schema carries the semantic load. The description adds nothing about parameters (it never mentions the optional 'subject'), which is the expected baseline of 3 when coverage is complete.

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 verb ('adds') and resource ('note to a vintrace stock item'), and the WRITE prefix immediately separates it from the read-oriented sibling vintrace_list_stock_item_notes. An agent can identify the operation without opening the schema.

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

Usage Guidelines3/5

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

The 'WRITE:' prefix implies this is the mutation counterpart to vintrace_list_stock_item_notes, and the duplicate-note behavior tells the agent not to use it for deduplicated logging. However, no sibling is named and there is no explicit when-to-use/when-not statement, so the routing is inferred rather than stated.

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.