Skip to main content
Glama
hvkshetry

inventree-mcp

by hvkshetry

return_order

Create, update, complete, cancel return orders and manage line items for returns handling.

Instructions

Return order lifecycle management in InvenTree.

Operations: Read: list, get, get_line_items Write: create, update, complete, cancel, add_line_item

Args: operation: One of the operations listed above. pk: Return order ID. data: Dict of fields for create/update/add_line_item. search: Text search filter for list. limit: Max results (default 25). offset: Pagination offset.

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

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
operationYes
pkNo
dataNo
searchNo
limitNo
offsetNo

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.0

TDQS

A4.5/5.0
Behavior4/5

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

Annotations provide readOnlyHint=false and destructiveHint=false. The description adds detail on return format and error handling, but does not discuss side effects, auth requirements, or rate limits. The operational list supplements the annotations well.

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?

The description is well-structured with clear sections for operations, args, and returns. It is concise but covers all necessary information, though a slight reduction in verbosity could improve it.

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

Completeness5/5

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

Given 6 parameters, nested objects, and an output schema, the description comprehensively covers operations, argument usage, and return format. It is sufficient for an agent to correctly invoke the tool.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters5/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

With 0% schema coverage, the description fully explains each parameter: operation, pk, data (dict for write ops), search, limit, offset. This adds critical meaning beyond the schema's type-only definitions.

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 it is for 'Return order lifecycle management' and lists specific read/write operations (list, get, create, update, complete, cancel, add_line_item). This distinguishes it from sibling order management tools like purchase_order and sales_order.

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?

The description enumerates the valid operations and their purposes, guiding the agent on when to use each. While it does not explicitly state exclusions or alternatives, the context of sibling tools implies when not to use this tool.

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