Search Inventory Tool
search-inventorySearches 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
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Maximum items to return. | |
| query | No | Inventory name, SKU, or description. | |
| active | No | Filter by active state; defaults to true. | |
| low_stock | No | Only items at or below minimum quantity. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| count | Yes | Count for the returned result. | |
| query | Yes | Query used or returned by this tool. | |
| scope | Yes | Authorization scope of this result; data remains restricted to the connected business. | |
| total | Yes | Total for the returned result. | |
| filters | Yes | Filters metadata; empty collections retain their existing JSON array representation. | |
| inventory | Yes | Bounded inventory records returned by this tool. |