Skip to main content
Glama

find_units_by_custom_field

Finds stock lines across the company where a unit custom field matches a value (case-insensitive contains). Use for lot recalls: fieldName "Lot #" and value "abc123". Returns item name, unit id, quantity, status, and the field value.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "fieldName": "<fieldName>",
      "value": "<value>"
    },
    "name": "find_units_by_custom_field"
  }
}

Input Schema

NameRequiredDescriptionDefault
valueYes
fieldNameYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.9/5.0
Behavior3/5

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

With no annotations, the description carries the full burden and does disclose the matching semantics (case-insensitive contains) and the search scope (across the company), which an agent could not get elsewhere. It omits result limits, pagination, and behavior on zero matches, which matter for a cross-company search that could return large result sets.

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?

Three short sentences, front-loaded with the core operation and match semantics, followed by the canonical use case and the return fields. Every sentence adds information and nothing is repeated from structured fields.

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 two-parameter read tool with no annotations and no output schema, the description covers purpose, match semantics, an example invocation, and the returned fields, which is close to sufficient. Missing result-size/pagination guidance is the only meaningful gap.

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?

Schema coverage is 0%, so the description must compensate, and it does: it explains that fieldName is a unit custom field name (example "Lot #") and that value is matched case-insensitively by containment. Remaining ambiguity is whether fieldName itself matches exactly or case-sensitively, which is left unstated.

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 gives a specific verb and resource ("Finds stock lines") plus the filtering rule (unit custom field matches a value, case-insensitive contains), which distinguishes it from plain listing siblings like list_inventory_units or list_unit_custom_fields. It stops short of naming those siblings explicitly, so the differentiation is inferred rather than stated.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

It provides a concrete when-to-use scenario ("Use for lot recalls") with a filled-in example (fieldName "Lot #", value "abc123"), which is strong positive guidance. There is no when-not guidance or pointer to alternatives such as find_item_by_barcode for barcode lookups, so it lands at 4 rather than 5.

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