Skip to main content
Glama

grocy_stock_overview

Read-only

Retrieve current inventory with each product's next due date to track stock and prioritize items expiring soon.

Instructions

Products currently in stock with next due date. GET /api/stock.

Input Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

B3.3/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true and destructiveHint=false, so the safety profile is covered. The description adds only a data-content hint (each entry carries a next due date); it says nothing about result size, sorting, or whether expired/zero-stock products are included. The trailing 'GET /api/stock' restates the implementation rather than adding behavior.

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?

Two short sentences with the essential information front-loaded. The raw endpoint path is filler that an agent cannot act on, but it costs only a few tokens.

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?

With no output schema and no parameters, the description is the only source of truth about what comes back, and it only names the next due date. It omits whether stock quantities, units, or product IDs are returned and whether the list is filtered or paginated.

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?

The tool takes zero parameters, so the schema carries no semantics to supplement; baseline 4 applies. The description correctly implies no filtering arguments are required.

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?

Names the resource and the scope clearly: products currently in stock, with the next due date. The plural 'Products' plus 'currently in stock' distinguishes it reasonably from grocy_stock_product (single product) and grocy_stock_volatile, though neither sibling is named.

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?

No statement of when to call this versus grocy_stock_product, grocy_stock_volatile, or grocy_stock_location_entries. The agent has to infer from the tool name that this is the aggregate overview rather than a per-product lookup.

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