Skip to main content
Glama
MCP-OpenStack-Ops

MCP-OpenStack-Ops

by call518

Get Instance By Name

get_instance_by_name

Retrieve detailed information for a specific OpenStack instance by name to inspect its configuration and status without listing every instance.

Instructions

Get detailed information for a specific instance by name.

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": {
      "instance_name": "<instance_name>"
    },
    "name": "get_instance_by_name"
  }
}

Input Schema

NameRequiredDescriptionDefault
instance_nameYesName of the instance to retrieve

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv3.5.8
    • addedInput schema / properties / instance_name / description
      Added value: +"Name of the instance to retrieve"
  2. First observedv0.1.0

TDQS

B3.2/5.0
Behavior2/5

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

No annotations are supplied, so the description carries the full behavioral burden, and it discloses almost nothing beyond the fact that this is a read. It does not say what happens when no instance matches the name, whether names are unique or case-sensitive, or whether the call is scoped to a tenant/project.

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?

One front-loaded sentence with no filler; the verb and the discriminating qualifier ('by name') come first. It is efficient, though the brevity comes at the cost of substance captured in other dimensions.

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

Completeness3/5

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

An output schema exists and the single parameter is fully documented in the schema, so return shape and argument meaning are covered elsewhere. What remains missing for a lookup-by-name tool is the not-found and ambiguity behavior, which the description does not address.

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?

There is a single parameter with 100% schema description coverage ('Name of the instance to retrieve'), so the schema already does the work. The description adds only the emphasis 'by name', which repeats rather than extends the schema's meaning.

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 states a specific verb ('Get') and resource ('detailed information for a specific instance') and names the lookup key ('by name'), which distinguishes it from an ID-based retrieval. It does not, however, distinguish itself from ambiguous siblings like get_instance_details, whose purpose could overlap with 'detailed information'.

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?

Usage is only implied: the phrase 'by name' hints that this is the name-addressed variant, but the description never states when to prefer it over an ID-based lookup or when not to use it. No alternatives are named and no prerequisites (e.g., name uniqueness, project scope) are given.

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