Skip to main content
Glama
MCP-OpenStack-Ops

MCP-OpenStack-Ops

by call518

Get Instance

get_instance

Retrieve, list, filter, or search OpenStack instances by ID, name, status, host, flavor, or image, with pagination and summary or detailed results.

Instructions

Unified instance query tool supporting all instance retrieval patterns. Consolidates functionality from get_instance_details, get_instance_by_name, get_instances_by_status, and search_instances.

Functions:

  • Get specific instances by names or IDs

  • Filter instances by status (ACTIVE, SHUTOFF, ERROR, etc.)

  • Search instances across multiple fields (name, flavor, image, host, etc.)

  • List all instances with pagination

  • Support both summary and detailed information modes

Use when user requests instance information, status checks, or instance searches.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "get_instance"
  }
}

Input Schema

NameRequiredDescriptionDefault
idsNoSpecific instance ID(s) to retrieve (comma-separated)
limitNoMaximum instances to return (default: 50; capped by the server LIST_MAX_LIMIT setting, default 100)
namesNoSpecific instance name(s) to retrieve (comma-separated: "vm1,vm2,vm3")
offsetNoNumber of instances to skip for pagination
statusNoFilter by instance status (e.g., "ACTIVE", "SHUTOFF", "ERROR")
detailedNoIf True, return detailed information; if False, return summary only
search_inNoFields to search in ("name", "status", "host", "flavor", "image", "availability_zone", "all")name
search_termNoSearch term for partial matching across fields
all_instancesNoIf True, retrieve all instances (ignores other filters)
case_sensitiveNoCase-sensitive search (default: False)

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv4.0.4
    • changedInput schema / properties / limit / description
      Previous value: -"Maximum instances to return (default: 50, max: 200)"New value: +"Maximum instances to return (default: 50; capped by the server LIST_MAX_LIMIT setting, default 100)"
  2. Changed10 schema fields changedv3.5.8
    • addedInput schema / properties / all_instances / description
      Added value: +"If True, retrieve all instances (ignores other filters)"
    • addedInput schema / properties / case_sensitive / description
      Added value: +"Case-sensitive search (default: False)"
    • addedInput schema / properties / detailed / description
      Added value: +"If True, return detailed information; if False, return summary only"
    • addedInput schema / properties / ids / description
      Added value: +"Specific instance ID(s) to retrieve (comma-separated)"
    • addedInput schema / properties / limit / description
      Added value: +"Maximum instances to return (default: 50, max: 200)"
    • addedInput schema / properties / names / description
      Added value: +"Specific instance name(s) to retrieve (comma-separated: \"vm1,vm2,vm3\")"
    • addedInput schema / properties / offset / description
      Added value: +"Number of instances to skip for pagination"
    • addedInput schema / properties / search_in / description
      Added value: +"Fields to search in (\"name\", \"status\", \"host\", \"flavor\", \"image\", \"availability_zone\", \"all\")"
    • addedInput schema / properties / search_term / description
      Added value: +"Search term for partial matching across fields"
    • addedInput schema / properties / status / description
      Added value: +"Filter by instance status (e.g., \"ACTIVE\", \"SHUTOFF\", \"ERROR\")"
  3. First observedv0.1.0

TDQS

A3.8/5.0
Behavior3/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. It does disclose the two output modes (summary vs detailed) and the general read-only nature via 'query', but says nothing about permissions, response volume, or what happens when conflicting filters (e.g. names plus status plus search_term) are combined. Reasonable, but not the full disclosure a mutation-capable or heavily filtered tool would need.

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?

Well structured: a one-line scope statement, a bulleted capability list, and a use-when sentence. Front-loaded and easy to scan. The consolidation sentence and the bullet list slightly overlap ('search' appears both as a bullet and in the use-when line), but there is no real filler.

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?

With 10 optional parameters, 100% schema coverage, and an output schema handling return values, the description does enough: it explains the patterns the parameter combinations map to and the two verbosity modes. The only material gap is guidance on how filters interact and which sibling (if any) should still be chosen instead.

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 description coverage is 100%, so the schema already documents every parameter including the LIST_MAX_LIMIT cap and the 'all_instances ignores other filters' caveat. The description adds a modest amount on top by grouping the parameters into named retrieval patterns and stating that both summary and detailed modes exist. It stops short of explaining filter precedence, which would be genuinely additive.

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 opens with a specific verb+resource ('Unified instance query tool') and enumerates the concrete retrieval patterns it supports (by names/IDs, by status, search, list, summary vs detailed). It names the four siblings it consolidates, which is strong differentiation, but those same siblings still appear in the available catalog, so an agent cannot tell whether they are deprecated or still preferred in some cases.

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

Usage Guidelines4/5

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

The closing line gives a clear trigger: 'Use when user requests instance information, status checks, or instance searches.' That covers the main usage contexts. What is missing is any exclusion or precedence rule relative to get_instance_by_name, get_instance_details, get_instances_by_status, and search_instances, which the description claims to replace but which are still listed as available.

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