Get form inventory
givingfuel_get_form_inventoryInventory items of a form (limited-quantity items): path, name, sold and remaining quantity. GET /forms/{id}/inventory.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| form_id | Yes | GivingFuel form id. |
givingfuel_get_form_inventoryInventory items of a form (limited-quantity items): path, name, sold and remaining quantity. GET /forms/{id}/inventory.
| Name | Required | Description | Default |
|---|---|---|---|
| form_id | Yes | GivingFuel form id. |
Changes observed during successful MCP inspections.
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=true, destructiveHint=false and openWorldHint=true, so the safety profile is covered. The description adds real value beyond them by enumerating the return fields (path, name, sold, remaining), which fills the gap left by the absent output schema; it stops short of noting empty-inventory behavior.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
One front-loaded clause plus the REST endpoint; every element (resource, qualifier, returned fields, path) earns its place with zero filler.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
With one simple parameter, no nested objects and no output schema, the description covers the essentials, including the returned field set that the missing output schema would otherwise have provided. Only edge cases (form without inventory, empty list, error behavior) are unaddressed.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Single required parameter form_id with 100% schema description coverage ('GivingFuel form id.'), so the schema already carries its meaning. The description adds nothing about the parameter — no note on ID format or where to obtain it — leaving this at baseline.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
States a specific verb+resource: retrieving inventory items of a form, parenthetically clarified as 'limited-quantity items', plus the exact fields returned. This clearly separates it from givingfuel_get_form and the list_* siblings, though it never names a sibling explicitly to draw the contrast.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Usage is implied by the resource description — you'd call it when you need sold/remaining counts for a form's limited-quantity items. There is no explicit when-to-use, no exclusions, and no mention of alternatives such as get_form for general form metadata.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Add one secure layer between your agents and this server.