Skip to main content
Glama

vsphere_get_vm

Retrieve detailed information about a specific vSphere VM by name, including configuration and status, to support inventory checks and troubleshooting.

Instructions

Get detailed information about a specific vSphere VM 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": {
      "name": "<name>"
    },
    "name": "vsphere_get_vm"
  }
}

Input Schema

NameRequiredDescriptionDefault
nameYes
gateway_idNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv0.72.5

TDQS

C2.7/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. 'Get' implies read-only, but nothing is said about required permissions, whether the name must be unique or exact-match, what happens on a miss, or what 'detailed information' actually comprises. For a lookup tool with zero annotation coverage this is a substantial gap.

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 well-formed sentence with the resource and lookup key front-loaded and no filler. It is concise to a fault — the brevity comes at the cost of content rather than from trimming redundancy.

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

Completeness2/5

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

With no output schema, no annotations, and 0% parameter coverage, the description should define what 'detailed information' returns and what gateway_id does. Neither is present, so an agent cannot predict the response shape or resolve the second parameter.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters2/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 0% across 2 parameters. The phrase 'by name' gives partial meaning to the required 'name' field, but the 'gateway_id' parameter is never mentioned and its purpose is completely opaque from schema or description. One of two parameters is effectively undocumented.

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') and resource ('detailed information about a specific vSphere VM') plus the lookup key ('by name'), which separates it from metric-oriented siblings such as vsphere_get_vm_metrics. It stops short of naming or contrasting any sibling explicitly, so it lands at clear-but-undifferentiated.

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 when-to-use guidance, no mention of prerequisites, and no routing to alternatives such as vsphere_list_vms for enumeration or vsphere_get_vm_metrics for performance data. The agent must infer from the name alone whether this is inventory lookup or something broader.

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

Deploy Server

Other Tools