mcp-vmwhere

取得虛擬機詳情

get_vm

Read-onlyIdempotent

Retrieve detailed information for one virtual machine by vm_id, including CPU, memory, disks, network adapters, power state, and guest OS identity when VMware Tools is running.

Instructions

取得單一虛擬機的詳細資訊。

彙整硬體設定(CPU、記憶體、磁碟、網卡)、電源狀態,以及客體 OS 身分資訊 (需 VM 開機且 VMware Tools 執行中才有客體資訊)。

參數: vm_id: VM 的 managed object id,例如 "vm-123"(可由 list_vms 取得)。

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": {
      "vm_id": "<vm_id>"
    },
    "name": "get_vm"
  }
}

Input Schema

Name	Required	Description	Default
`vm_id`	Yes

Output Schema

Name	Required	Description	Default
`power`	No
`vm_id`	Yes
`details`	No
`guest_identity`	No
`guest_identity_note`	No

Schema Changelog

Changes observed during successful MCP inspections.

First observedv0.1.0Nov 7, 2026

TDQS

A4.5/5.0

Behavior4/5

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

Annotations already declare readOnly, idempotent, non-destructive, openWorld, so the safety profile is covered. The description adds genuinely new behavior: guest OS fields are conditionally absent unless the VM is powered on and VMware Tools is running, which prevents misreading an empty guest section as an error. It does not discuss failure modes for an invalid or nonexistent vm_id.

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

Conciseness5/5

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

Two short blocks: a one-line purpose plus a bulleted summary of returned data, then a compact parameter note. Everything is front-loaded and no sentence is redundant.

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

Completeness5/5

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

For a one-parameter read tool with rich annotations and an output schema, nothing essential is missing: purpose, returned field groups, conditional availability of guest data, and parameter provenance are all stated. Return-value shape is correctly left to the output schema.

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 0%, so the description must carry the meaning and it does: vm_id is identified as a managed object id, given a concrete format example ("vm-123"), and a provenance hint (obtainable from list_vms). It stops short of stating whether the id is case-sensitive or what happens on a malformed id.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb and scope (取得單一虛擬機的詳細資訊) and enumerates exactly what is aggregated: hardware config (CPU, memory, disk, NIC), power state, and guest OS identity. The word 單一 paired with the note that vm_id comes from list_vms makes the boundary against the list_* siblings unambiguous.

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?

Gives a clear precondition for guest OS data (VM powered on and VMware Tools running) and routes the agent to list_vms for obtaining the identifier. It does not explicitly state when not to use this tool (e.g. bulk listing), but the single-VM framing makes the intended context evident.

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

Deploy Server