Skip to main content
Glama

Remove inventory

farmbrite_remove_inventory
Destructive

WRITE: take stock out of an inventory item in a storage location (use, loss, sale). Lowers the quantity remaining; not idempotent: repeating removes again. It cannot be undone with this server except by adding stock back. PUT /inventory_types/{id}/inventory/remove.

Input Schema

NameRequiredDescriptionDefault
dateNo
bin_idNoBin id inside the warehouse (a Farmbrite id string).
order_idNoOrder id the stock was used for (a Farmbrite id string).
adjustmentYesQuantity to remove (positive, in the item's unit).
lot_numberNo
descriptionNo
warehouse_idYesStorage location (warehouse) id (a Farmbrite id string).
inventory_type_idYesInventory type id (a Farmbrite id string).

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.2/5.0
Behavior4/5

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

Annotations already mark the tool as destructive and non-idempotent, and the description reinforces this by stating that repeating removes stock again and that the action cannot be undone except by adding stock back. It stops short of describing permissions or rate limits, but adds meaningful consequence detail beyond the structured hints.

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 tightly front-loaded with the write operation and key caveats, then ends with the endpoint. Every sentence adds useful information without repetition or waste.

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 destructive inventory mutation, the description covers the essential behavioral risks: non-idempotence, irreversible stock reduction, and the only in-server recovery path. It does not address the optional parameters or permissions, but the annotations and schema cover enough that the definition 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?

The schema already describes the three required IDs and the adjustment quantity, but three optional parameters (date, lot_number, description) lack schema descriptions. The tool description does not compensate by explaining those fields or adding meaning beyond the existing parameter documentation.

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 specific verb and resource: taking stock out of an inventory item in a storage location. It explicitly labels the operation as a WRITE and names the endpoint, making it clearly distinguishable from add/read inventory siblings.

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?

It gives concrete usage contexts (use, loss, sale) and explains the consequence of repeating the call. It does not explicitly name the alternative tool for adding stock back, but the implication is clear enough for an agent to infer the inverse operation.

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.