boaviztapi-mcp

Describe a catalog item

describe_catalog_item

Read-onlyIdempotent

Show a catalog item's specs and defaults—cloud instance vCPUs/memory/host, archetype parts, or CPU/GPU details—to check estimate assumptions or compare similar items; it does not estimate impacts.

Instructions

Show what a named catalog item contains: a cloud instance's vCPUs, memory and host platform; a server or device archetype's default parts and usage; or a GPU's or CPU's specifications.

Use it to explain or check the assumptions behind an estimate, or to choose between similar items; it does not estimate impacts. name is resolved to the exact upstream name, and an ambiguous name returns the candidates (use search_catalog to find names). provider is required for cloud_instance and device_type for device_archetype. Read-only; 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": "<name>"
    },
    "name": "describe_catalog_item"
  }
}

Input Schema

Name	Required	Description
`kind`	Yes	What kind of item.
`name`	Yes	Name as found with search_catalog.
`provider`	No	Required for cloud_instance.
`device_type`	No	Required for device_archetype.

Output Schema

Name	Required	Description	Default
`kind`	Yes
`name`	Yes
`details`	Yes
`summary`	Yes

Schema Changelog

Changes observed during successful MCP inspections.

First observedv0.1.0Nov 13, 2026

TDQS

A4.3/5.0

Behavior4/5

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

Annotations already declare readOnly/idempotent/non-destructive, but the description adds behavior the annotations cannot express: 'cached for a day' and, more importantly, name-resolution semantics where an ambiguous name returns candidate matches rather than failing. The 'Read-only' restatement is redundant with readOnlyHint=true, which keeps it from a 5.

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 payoff (what you get back per kind) followed by usage, resolution behavior, and conditional requirements; there is little filler. Minor waste in restating the provider/device_type conditionals that already sit in the schema.

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?

An output schema exists so return values need no explanation, and the description still covers all five kinds plus the conditional-parameter rules and the ambiguous-name path. It could say slightly more about what the candidate list looks like when a name is ambiguous, but nothing essential to calling it is missing.

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

Parameters3/5

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

With 100% schema description coverage the schema already documents all four parameters, including the 'Required for cloud_instance' and 'Required for device_archetype' notes the description repeats verbatim. The only genuine addition is 'name is resolved to the exact upstream name' and the ambiguity fallback, so value beyond the schema is modest.

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?

Names a specific verb ('Show what a named catalog item contains') and enumerates exactly what is returned for each of the five kinds (vCPUs/memory/host platform, default parts and usage, GPU/CPU specs). It also explicitly separates itself from siblings by stating 'it does not estimate impacts', so an agent can distinguish it from estimate_cloud_instance and friends without opening a 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 concrete situations to use it ('explain or check the assumptions behind an estimate, or to choose between similar items') and an explicit exclusion ('it does not estimate impacts'), which routes estimation work to the estimate_* tools. It also names the prerequisite lookup tool: 'use search_catalog to find names'.

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

Deploy Server