Skip to main content
Glama
MCP-OpenStack-Ops

MCP-OpenStack-Ops

by call518

Search Instances

search_instances

Search OpenStack instances by name, status, host, flavor, image, or availability zone using partial matching, case sensitivity, and pagination.

Instructions

Search for OpenStack instances based on various criteria with efficient pagination.

Functions:

  • Search instances by name, status, host, flavor, image, or availability zone

  • Support partial matching with configurable case sensitivity

  • Return detailed information for matching instances with pagination

  • Optimized for large-scale environments with intelligent filtering

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": {
      "search_term": "<search_term>"
    },
    "name": "search_instances"
  }
}

Input Schema

NameRequiredDescriptionDefault
limitNoMaximum number of matching instances to return (default: 50; capped by the server LIST_MAX_LIMIT setting, default 100)
offsetNoNumber of matching instances to skip for pagination (default: 0)
search_inNoField to search in ('name', 'status', 'host', 'flavor', 'image', 'availability_zone', 'all')name
search_termYesTerm to search for (supports partial matching)
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.
case_sensitiveNoIf True, performs case-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 number of matching instances to return (default: 50, max: 200)"New value: +"Maximum number of matching instances to return (default: 50; capped by the server LIST_MAX_LIMIT setting, default 100)"
  2. 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 --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. Changed5 schema fields changedv3.5.8
    • addedInput schema / properties / case_sensitive / description
      Added value: +"If True, performs case-sensitive search (default: False)"
    • addedInput schema / properties / limit / description
      Added value: +"Maximum number of matching instances to return (default: 50, max: 200)"
    • addedInput schema / properties / offset / description
      Added value: +"Number of matching instances to skip for pagination (default: 0)"
    • addedInput schema / properties / search_in / description
      Added value: +"Field to search in ('name', 'status', 'host', 'flavor', 'image', 'availability_zone', 'all')"
    • addedInput schema / properties / search_term / description
      Added value: +"Term to search for (supports partial matching)"
  4. First observedv0.1.0

TDQS

B3.3/5.0
Behavior3/5

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

With no annotations supplied, the description carries the disclosure burden and does add some behavior: partial matching, configurable case sensitivity, and paginated detailed results. However, it omits the read-only nature, the server-side cap on results, and the fact that cross-project reads can be rejected outright — details that live only in the parameter schema, not the prose.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness3/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The front-loaded first sentence is good, but the bullet list mostly restates it — 'efficient pagination' in the opening line and 'with pagination' in the third bullet are redundant. The bullets read as a feature brochure rather than routing guidance the agent can act on.

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 every parameter is fully described in the schema, so the description need not explain return values or argument formats. Still, for a 6-parameter search entry point with many overlapping siblings, it provides no selection guidance, leaving a meaningful contextual gap.

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 baseline is 3. The description's field list loosely mirrors the search_in enum values and mentions case sensitivity and pagination, but it adds no syntax, default values, or edge-case meaning beyond what the schema already documents.

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 concrete verb and resource ('Search for OpenStack instances') and enumerates the searchable fields (name, status, host, flavor, image, availability zone), so an agent knows what the tool does. It does not name any sibling (e.g., get_instance_by_name or get_instances_by_status) to disambiguate, which is why it stops short of a 5.

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 criteria list suggests this is the general-purpose filtered query over instances, but there is no statement of when to prefer it over get_instance_by_name, get_instance_details, or get_instances_by_status. No exclusions or prerequisites (e.g., credential policy for cross-project reads) are given in the description itself.

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