Skip to main content
Glama

square_get_inventory

Retrieve inventory counts for specific Square catalog items, optionally filtered by location.

Instructions

Fetch Square inventory counts for one or more catalog items.

Args: catalog_object_ids (required): Catalog object IDs to fetch inventory counts for. location_ids: Optional location IDs to restrict counts to.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
catalog_object_idsNo
location_idsNo

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes
Behavior2/5

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

With no annotations, the description should disclose behavioral traits but only states it 'fetches' counts. It doesn't mention read-only nature, pagination, rate limits, or that no mutations occur.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Two sentences plus a parameter list, no wasted words. Front-loaded with the purpose. Efficiently structured.

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 output schema exists, the description need not detail returns, but it omits context like default behavior when location_ids are omitted, error conditions, or needed prior steps like searching catalog items.

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 adds meaning beyond the schema by explaining the two parameters (catalog_object_ids as required, location_ids as optional). However, it contradicts the schema which marks catalog_object_ids as optional (default null). With 0% schema coverage, the description compensates partially but lacks examples or constraints.

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 the verb 'Fetch' and the resource 'Square inventory counts for one or more catalog items', distinguishing it from sibling tools like square_get_catalog_item or square_get_order.

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 guidance on when to use this tool versus alternatives, no prerequisites or context provided. The description merely lists parameters without usage context.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/RPasquale/lightbulb-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server