boaviztapi-mcp

Search the BoaviztAPI catalog

search_catalog

Read-onlyIdempotent

Find exact BoaviztAPI names for GPUs, CPUs, cloud instances and regions, server or device archetypes, and countries before estimating environmental impact.

Instructions

Find the exact names BoaviztAPI knows, before estimating.

Use it whenever an estimate needs a name you are unsure of: a GPU or CPU model, a cloud instance type (needs provider), a cloud region, a server or device archetype (needs device_type), or a country. Results are exact upstream strings, including upstream typos such as 'platfom_gpucompute_high', best matches first and capped by limit; total_matches says how many exist. To see what one item contains, use describe_catalog_item instead. Read-only; lists are cached for a day.

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": {
      "kind": "<kind>"
    },
    "name": "search_catalog"
  }
}

Input Schema

Name	Required	Description
`kind`	Yes	What to search.
`limit`	No	Maximum names to return.
`query`	No	Words to match, e.g. 'h100', 'm5.x', 'germ'.
`provider`	No	Cloud provider; required for cloud_instance, optional for cloud_region.
`device_type`	No	Required for device_archetype.

Output Schema

Name	Required	Description	Default
`kind`	Yes
`names`	Yes
`query`	Yes
`summary`	Yes
`total_matches`	Yes

Schema Changelog

Changes observed during successful MCP inspections.

First observedv0.1.0Nov 13, 2026

TDQS

A4.8/5.0

Behavior5/5

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

Annotations already cover the safety profile (readOnly, idempotent, non-destructive, openWorld), yet the description adds real behavior: results are verbatim upstream strings including upstream typos, ordered best-match first, capped by limit, and accompanied by total_matches. The caching note ('lists are cached for a day') discloses staleness an agent could not infer from annotations.

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-loaded with the core purpose, then a single efficient em-dash list covering kinds, followed by result semantics and the alternative. Slightly long because the kind list partially restates the schema enum, but no sentence is filler.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Complete for a five-parameter search tool: it explains what is searched, what comes back (ordering, cap, total_matches), staleness, and the handoff to describe_catalog_item. With an output schema present, it does not over-explain return values.

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 100%, so the parameter baseline is 3. The description earns a bump by tying parameters to kinds (provider needed for cloud instances, device_type for device archetypes) and by explaining the returned count via total_matches, but it does not clarify query matching semantics beyond one example.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a concrete verb and resource ('Find the exact names BoaviztAPI knows') and immediately scopes it as a lookup step before estimating. It explicitly separates itself from describe_catalog_item, which handles the details of a single item, so an agent can pick correctly without opening either schema.

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

Usage Guidelines5/5

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

Gives an explicit trigger ('whenever an estimate needs a name you are unsure of') and enumerates the name categories that qualify, including conditional requirements per kind. It also names the alternative (describe_catalog_item) and what that alternative is for.

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

Deploy Server