Skip to main content
Glama
hvkshetry

inventree-mcp

by hvkshetry

report

Generate, list, print, and download report templates for InvenTree items.

Instructions

Report generation and template management in InvenTree.

Operations: list_templates, print_report, download_template

Args: operation: One of the operations listed above. template_id: Report template ID for print_report/download_template. item_ids: List of item IDs to include in report. model_type: Model type for print_report. destination: File path to save downloaded template to.

Returns: JSON string with report templates or print result.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
operationYes
template_idNo
item_idsNo
model_typeNo
destinationNo

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.0

TDQS

B3.2/5.0
Behavior3/5

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

Annotations indicate readOnlyHint=false (modifications possible) and openWorldHint=true (unexpected side effects possible). The description adds the return format (JSON string) but does not elaborate on behavioral traits like permissions needed, whether print_report sends to a physical printer, or how download_template behaves. No contradictions with annotations.

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 sections for operations, args, and returns. It is relatively concise at a few lines, though it could be slightly more compact by integrating operation descriptions with the args. No unnecessary sentences.

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 has 5 parameters, multiple operations, and an output schema, the description is somewhat incomplete. It does not explain what each operation returns (though output schema may cover that) or clarify the behavior of operations like 'list_templates' or 'print_report' in detail. The description covers the essentials but leaves gaps.

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 description provides basic meanings for each parameter (e.g., 'template_id for print_report/download_template'), which adds value beyond the empty schema descriptions (coverage 0%). However, it lacks details like valid model_type values or the format of destination, so it compensates only partially for the schema's lack of descriptions.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the tool handles report generation and template management in InvenTree, listing three operations (list_templates, print_report, download_template). This provides a specific verb-resource pairing and differentiates the tool from siblings like 'label' or 'attachment', though it could be more explicit about the overall single-tool nature.

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

Usage Guidelines2/5

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

The description lacks guidance on when to use this tool versus alternatives or how to choose between the three operations. No exclusion criteria or context for selecting an operation is provided, leaving the agent to infer usage from operation names alone.

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