Search tracked product families by vendor, product line, or series name (case-insensitive substring, e.g. "nexus 9300"). Read-only. Returns up to 10 families with status, EOSL window, and page URL. Use this for discovery when you have a name; for an exact part number use lookup_part, and use get_family with a returned slug for the full record.
| Name | Required | Description | Default |
|---|---|---|---|
| query | Yes | Search text, 1-120 characters. |
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are provided, so the description carries full burden. It discloses that the operation is read-only, returns up to 10 families, includes specific fields (status, EOSL window, page URL), and uses case-insensitive substring matching. This is substantial behavioral disclosure beyond the schema.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is only two sentences, front-loaded with the purpose, and packs in a concrete example, return limits, result fields, and usage alternatives without redundancy.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a single-parameter search tool with no annotations or output schema, the description provides all essential context: what it searches, what it returns, how to use it, and how it fits with sibling tools. There are no critical gaps.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The schema already covers the query parameter with 100% coverage (length constraints). The description adds meaning by specifying search scope (vendor, product line, series name), an example ('nexus 9300'), and matching semantics (case-insensitive substring), which goes beyond the schema's minimal description.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the tool's function with a specific verb and resource: 'Search tracked product families by vendor, product line, or series name.' It also distinguishes from siblings by explicitly referencing lookup_part and get_family for different use cases.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
It provides explicit guidance: 'Use this for discovery when you have a name; for an exact part number use lookup_part, and use get_family with a returned slug for the full record.' This clearly delineates when to use this tool versus alternatives.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Add one secure layer between your agents and this server.
Each tool serves a distinct purpose: bulk_check for batch part lookups, lookup_part for single parts, search_models for discovery by name, get_family for full family details, and list_vendors for vendor enumeration. No two tools overlap in their primary use case, and cross-references in descriptions further clarify boundaries.
Four of five tools follow a clear verb_noun pattern (get_family, list_vendors, lookup_part, search_models). bulk_check deviates slightly as a compound modifier + noun, but all names are lowercase snake_case and semantically intuitive, making the set predictable overall.
Five tools is ideal for a focused read-only database. The set covers discovery, single lookup, batch lookup, and deep record retrieval without unnecessary redundancy or bloat.
The tool surface fully covers the domain of a hardware EOL database: list_vendors confirms coverage, search_models finds families, lookup_part and bulk_check handle part lookups, and get_family provides comprehensive lifecycle data. No obvious operations are missing for the stated read-only purpose.