Skip to main content
Glama
MCP-OpenStack-Ops

MCP-OpenStack-Ops

by call518

Get Instances By Status

get_instances_by_status

Filter OpenStack Nova instances by status to find servers in states like ACTIVE, ERROR, or SHUTOFF, with optional cross-project listing when policy allows.

Instructions

Get instances filtered by status.

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": {
      "status": "<status>"
    },
    "name": "get_instances_by_status"
  }
}

Input Schema

NameRequiredDescriptionDefault
statusYesNova server status to filter by, case-insensitive (ACTIVE, BUILD, DELETED, ERROR, HARD_REBOOT, MIGRATING, PASSWORD, PAUSED, REBOOT, REBUILD, RESCUE, RESIZE, REVERT_RESIZE, SHELVED, SHELVED_OFFLOADED, SHUTOFF, SOFT_DELETED, SUSPENDED, UNKNOWN, VERIFY_RESIZE)
all_projectsNoIf True, include every project the credential's OpenStack policy allows (like 'openstack server list --status --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.

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv3.8.7
    • 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 --status --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"
      +}
  2. Changed1 schema field changedv3.8.3
    • changedInput schema / properties / status / description
      Previous value: -"Instance status to filter by (ACTIVE, SHUTOFF, ERROR, BUILDING, etc.)"New value: +"Nova server status to filter by, case-insensitive (ACTIVE,\nBUILD, DELETED, ERROR, HARD_REBOOT, MIGRATING, PASSWORD, PAUSED,\nREBOOT, REBUILD, RESCUE, RESIZE, REVERT_RESIZE, SHELVED,\nSHELVED_OFFLOADED, SHUTOFF, SOFT_DELETED, SUSPENDED, UNKNOWN,\nVERIFY_RESIZE)"
  3. Changed1 schema field changedv3.5.8
    • addedInput schema / properties / status / description
      Added value: +"Instance status to filter by (ACTIVE, SHUTOFF, ERROR, BUILDING, etc.)"
  4. First observedv0.1.0

TDQS

C2.9/5.0
Behavior2/5

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

No annotations are provided, so the description carries the full behavioral burden, yet it says nothing about read-only semantics, result volume, pagination, or default project scoping. The genuinely useful behavioral caveats (cross-project reads require ALLOW_CROSS_PROJECT_READ=true, denials surface as errors) live only in the schema property text, not in the description.

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?

A single front-loaded sentence with no filler or redundancy. It is efficient, though the brevity comes at the cost of the guidance and behavioral detail noted elsewhere.

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?

The tool is simple (2 params, one required, output schema present) and the schema is fully documented, which lowers the bar. Still, for a listing tool with no annotations, the description should at least state that it returns all instances matching the status in the current project by default.

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% and the 'status' property already enumerates valid Nova status values case-insensitively, so the description has little room to add meaning. Baseline 3 applies since the schema does all the work and the description repeats nothing useful about the parameters.

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?

States a specific verb ('Get'), resource ('instances'), and the filtering dimension ('by status'), which is more than a restatement of the name. It does not, however, differentiate itself from siblings like search_instances or get_instance_by_name, so the agent must infer that this is the status-scoped listing.

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

Usage Guidelines2/5

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

There is no guidance on when to use this versus search_instances or get_instance_by_name, and no mention of prerequisites or exclusions. The only routing signal an agent gets is the word 'status' in the name and description.

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