Skip to main content
Glama

search_inventory

Find matching workloads in a Cisco Secure Workload cluster inventory by filtering on IP, hostname, OS, or annotations; returns counts and matching records.

Instructions

Search cluster inventory for workloads matching a field/value filter.

Args: value: The value to match (e.g. an IP, hostname fragment, OS string). field: The inventory dimension to filter on (default "ip"). Common fields: "ip", "hostname", "os", "user_annotations". match: CSW filter operator — "eq" (exact), "contains", "subnet", etc. Defaults to "eq". limit: Max results to return (1–1000).

Runs a read-only POST /openapi/v1/inventory/search. Returns a count and the matching inventory records.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
fieldNoip
limitNo
matchNoeq
valueYes

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4/5.0
Behavior4/5

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

With no annotations, the description carries the full burden and largely delivers: it discloses that the underlying call is read-only despite being a POST, and states the return shape (count plus matching records). It does not cover auth requirements, rate limits, or pagination behavior beyond the limit parameter.

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?

Front-loads the core purpose before the Args list and keeps each parameter entry to a single line. The closing sentence restates the return shape that the existing output schema already covers, which is minor redundancy, but the structure is otherwise efficient.

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 4-parameter search tool with an output schema present, the definition supplies the read-only nature, the filtering model, and full parameter semantics. Only ancillary operational details (auth, rate limits) are absent, which are not essential to correct invocation.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters5/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 0%, so the description must carry all parameter meaning, and it does: it explains value (with examples), field (default and common values), match (operators and default 'eq'), and limit (explicit 1–1000 range not present in the schema). Every parameter gains semantics beyond the bare schema titles.

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?

States a specific verb and resource ('Search cluster inventory for workloads') plus the filtering mechanism (field/value). It implicitly distinguishes itself from search_flows by scoping to inventory/workloads, but never names a sibling explicitly, so differentiation is only inferable 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 Guidelines3/5

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

Provides implied usage by listing common field values ('ip', 'hostname', 'os', 'user_annotations') and match operators, which hints at when the tool applies. However, there is no explicit when-to-use vs. when-not-to-use guidance and no mention of the closely related search_flows alternative.

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