Skip to main content
Glama
MCP-OpenStack-Ops

MCP-OpenStack-Ops

by call518

Get Instance Details

get_instance_details

Retrieve detailed OpenStack instance status, network IPs, resource usage, metadata, and security settings with pagination to troubleshoot VMs or analyze server details.

Instructions

Provides detailed information and status for OpenStack instances with pagination support.

Functions:

  • Query basic instance information (name, ID, status, image, flavor) with efficient pagination

  • Collect network connection status and IP address information

  • Check CPU, memory, storage resource usage and allocation

  • Provide instance metadata, keypair, and security group settings

  • Support large-scale environments with configurable limits

Use when user requests specific instance information, VM details, server analysis, or instance troubleshooting.

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_details"
  }
}

Input Schema

NameRequiredDescriptionDefault
limitNoMaximum number of instances to return (default: 50; capped by the server LIST_MAX_LIMIT setting, default 100)
offsetNoNumber of instances to skip for pagination (default: 0)
include_allNoIf True, ignore pagination limits (use with caution in large environments)
all_projectsNoIf True, include every project the credential's OpenStack policy allows (like 'openstack server list --all-projects'). Requires ALLOW_CROSS_PROJECT_READ=true on the server; a disabled or denied request is reported as an error, never as current-project results.
instance_idsNoComma-separated list of instance IDs to query (optional)
all_instancesNoIf True, returns all instances of the current project (default: False)
instance_namesNoComma-separated list of instance names to query (optional)

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 number of instances to return (default: 50, max: 200)"New value: +"Maximum number of instances to return (default: 50; capped by the server LIST_MAX_LIMIT setting, default 100)"
  2. Changed2 schema fields changedv3.8.7
    • changedInput schema / properties / all_instances / description
      Previous value: -"If True, returns all instances (default: False)"New value: +"If True, returns all instances of the current project (default: False)"
    • addedInput schema / properties / all_projects
      Added value: +{
      +  "default": false,
      +  "description": "If True, include every project the credential's OpenStack\npolicy allows (like 'openstack server list --all-projects'). Requires\nALLOW_CROSS_PROJECT_READ=true on the server; a disabled or denied\nrequest is reported as an error, never as current-project results.",
      +  "type": "boolean"
      +}
  3. Changed6 schema fields changedv3.5.8
    • addedInput schema / properties / all_instances / description
      Added value: +"If True, returns all instances (default: False)"
    • addedInput schema / properties / include_all / description
      Added value: +"If True, ignore pagination limits (use with caution in large environments)"
    • addedInput schema / properties / instance_ids / description
      Added value: +"Comma-separated list of instance IDs to query (optional)"
    • addedInput schema / properties / instance_names / description
      Added value: +"Comma-separated list of instance names to query (optional)"
    • addedInput schema / properties / limit / description
      Added value: +"Maximum number of instances to return (default: 50, max: 200)"
    • addedInput schema / properties / offset / description
      Added value: +"Number of instances to skip for pagination (default: 0)"
  4. First observedv0.1.0

TDQS

B3.4/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 burden. It does disclose pagination behavior and the large-environment caution, and it lists the categories of data returned, which is genuinely useful; but it never states that this is a read-only operation, what authorization the cross-project path requires (only the schema mentions ALLOW_CROSS_PROJECT_READ), or how results are ordered/truncated.

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?

The purpose is front-loaded in one sentence, then a scannable bullet list, then a usage line. A few bullets restate the same idea (pagination appears in the header, a bullet, and 'Support large-scale environments with configurable limits'), which is slight padding but not damaging.

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, so return-value documentation is not required, and the schema itself is fully described. Still, for a seven-parameter query tool with no annotations, the description leaves unclear how the filtering parameters (instance_ids, instance_names, all_instances) interact with pagination and cross-project mode, which an agent needs to call it correctly.

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?

Schema description coverage is 100%, so the schema already documents limit, offset, include_all, all_projects, instance_ids, instance_names and all_instances in detail. The description adds only the loose notions of 'efficient pagination' and 'configurable limits' and does not clarify interactions among the seven parameters, so the baseline of 3 applies.

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 opening sentence gives a specific verb and resource ('Provides detailed information and status for OpenStack instances') and the bullet list enumerates the data returned (network status, IPs, CPU/memory/storage, metadata, keypair, security groups). However, it never distinguishes itself from the sibling tools get_instance and get_instance_by_name, whose names suggest overlapping single-instance lookups.

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?

The final line gives a when-to-use cue ('user requests specific instance information, VM details, server analysis, or instance troubleshooting'), which is real but generic. There is no when-not guidance and no routing to get_instance / get_instance_by_name / get_instances_by_status, so an agent facing those siblings must guess.

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