inventree-mcp

by hvkshetry

Overview Schema Source Related Servers Discussions Admin

Python

Remote

sales_order

Manage sales order lifecycle: create, read, update, complete, cancel, hold, and add line items or shipments.

Instructions

Sales order lifecycle management in InvenTree.

Operations: Read: list, get, get_line_items, get_allocations Write: create, update, complete, cancel, hold, add_line_item, add_extra_line_item, create_shipment, complete_shipment

Args: operation: One of the operations listed above. pk: Sales order ID. data: Dict of fields for create/update/add_line_item. shipment_id: Shipment ID for complete_shipment. reference: Reference string for create_shipment. search: Text search filter for list. limit: Max results (default 25). offset: Pagination offset.

Returns: JSON string with SO data or {"error": "..."}.

Input Schema

TableJSON Schema

Name	Required	Description	Default
`operation`	Yes
`pk`	No
`data`	No
`shipment_id`	No
`reference`	No
`search`	No
`limit`	No
`offset`	No

Output Schema

TableJSON Schema

Name	Required	Description	Default
`result`	Yes

Schema Changelog

Changes observed during successful MCP inspections.

First observedv1.0.0Jun 3, 2026

TDQS

A3.7/5.0

Behavior3/5

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

Annotations already indicate the tool is not read-only and not destructive; the description adds the list of write operations but does not disclose further behaviors (e.g., side effects on inventory), providing marginal added value.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness3/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is front-loaded with the purpose but repeats the operation list twice (in the text and as a parameter), making it longer than necessary and slightly redundant.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the tool's complexity (multiple operations, 8 parameters, output schema), the description covers the operations and parameters adequately but lacks guidance on when to use specific operations, leaving some gaps.

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?

With 0% schema description coverage, the description compensates by naming all 8 parameters and briefly explaining each (e.g., 'operation: one of the operations'), adding valuable semantic context beyond the schema's bare titles.

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 clearly states 'Sales order lifecycle management in InvenTree' and lists all specific operations, making the tool's purpose unambiguous and distinct from sibling tools like purchase_order.

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 description specifies that the tool handles sales order lifecycle operations but does not explicitly compare with alternative tools or state when not to use it, limiting guidance for an agent.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Deploy Server