Skip to main content
Glama
hvkshetry

inventree-mcp

by hvkshetry

system

Read-onlyIdempotent

Perform health checks and retrieve system information including version, settings, users, groups, owners, project codes, and currencies.

Instructions

InvenTree system administration and health checks.

Operations: health, version, settings, list_users, get_user, list_groups, list_owners, get_project_codes, list_currencies

All operations are read-only.

Args: operation: One of the operations listed above. pk: User ID for get_user.

Returns: JSON string with system data.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
operationYes
pkNo

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.0

TDQS

A3.9/5.0
Behavior3/5

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

Annotations already declare readOnlyHint, idempotentHint, and not destructive. The description adds that all operations are read-only and lists operations, but does not disclose other behavioral traits such as permission requirements or rate limits. Given high annotation coverage, description adds moderate context.

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?

Description is concise with sections for operations, args, and returns. It is front-loaded with the purpose. Minor improvement could be more structured formatting, but it earns its sentences.

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?

Given complexity (multiple operations), presence of output schema, and good annotations, the description sufficiently explains the tool's behavior. It lists all operations and parameter usage, though could add details on response structure despite output schema.

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?

Parameter count is 2 and schema has 0% description coverage, so description must compensate. It explains that 'operation' is a choice from listed values and 'pk' is for get_user, providing meaning beyond the raw schema types.

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 system administration and health checks, listing specific operations and stating they are read-only. It distinguishes itself from sibling tools like 'part' and 'stock' by targeting system-level tasks.

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 implies use for system admin tasks but does not explicitly provide when-to-use or when-not-to-use guidance relative to sibling tools. No alternatives or exclusions are mentioned.

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