Skip to main content
Glama

Search Inventory Tool

search-inventory
Read-only

Searches active inventory in the authenticated workspace and can identify low-stock items without exposing internal cost or margin fields. Use to search inventory in the connected business. Returns query, count, total, inventory, filters, scope.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "search-inventory"
  }
}

Input Schema

NameRequiredDescriptionDefault
limitNoMaximum items to return.
queryNoInventory name, SKU, or description.
activeNoFilter by active state; defaults to true.
low_stockNoOnly items at or below minimum quantity.

Output Schema

NameRequiredDescriptionDefault
countYesCount for the returned result.
queryYesQuery used or returned by this tool.
scopeYesAuthorization scope of this result; data remains restricted to the connected business.
totalYesTotal for the returned result.
filtersYesFilters metadata; empty collections retain their existing JSON array representation.
inventoryYesBounded inventory records returned by this tool.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "properties": {
      +    "count": {
      +      "description": "Count for the returned result.",
      +      "type": "integer"
      +    },
      +    "filters": {
      +      "description": "Filters metadata; empty collections retain their existing JSON array representation.",
      +      "type": [
      +        "object",
      +        "array",
      +        "null"
      +      ]
      +    },
      +    "inventory": {
      +      "description": "Bounded inventory records returned by this tool.",
      +      "items": {
      +        "type": "object"
      +      },
      +      "type": "array"
      +    },
      +    "query": {
      +      "description": "Query used or returned by this tool.",
      +      "type": [
      +        "string",
      +        "null"
      +      ]
      +    },
      +    "scope": {
      +      "description": "Authorization scope of this result; data remains restricted to the connected business.",
      +      "enum": [
      +        "connection_business"
      +      ],
      +      "type": "string"
      +    },
      +    "total": {
      +      "description": "Total for the returned result.",
      +      "type": "integer"
      +    }
      +  },
      +  "required": [
      +    "query",
      +    "count",
      +    "total",
      +    "inventory",
      +    "filters",
      +    "scope"
      +  ],
      +  "type": "object"
      +}
  2. First observed

TDQS

A3.7/5.0
Behavior4/5

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

Annotations already establish this as a read-only, non-destructive, closed-world operation. The description adds useful behavioral context by limiting results to active inventory, supporting low-stock identification, and explicitly stating that internal cost and margin fields are not exposed.

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 short and front-loads the core purpose. The second sentence ("Use to search inventory in the connected business") partly repeats the first, and the return-field list is somewhat redundant given the output schema, but neither overwhelms the useful content.

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?

For a simple four-parameter search tool with full schema coverage, annotations, and an output schema, the description covers scope, sensitive-field behavior, and low-stock support. It does not need to explain return values because an output schema exists, though additional guidance on sibling-search selection would make it more complete.

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?

Schema description coverage is 100%, so all four parameters are already documented in the input schema. The description reinforces active inventory and low-stock filtering but adds little syntax or semantics beyond what the schema provides.

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 states a specific verb and resource ("Searches active inventory") plus workspace scope, and notes low-stock identification and excluded cost/margin fields. It clearly identifies the inventory domain, though it does not explicitly contrast itself with the other search-* siblings.

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?

It gives a usage cue with "Use to search inventory in the connected business" but offers no when-not conditions, prerequisites, or named alternatives. The guidance is implied rather than explicit for choosing among sibling search tools.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources