vmware-mcp

by havu0

Overview Schema Source Related Servers Discussions Admin

TypeScript

Local

Read VM Variable

vm_read_variable

Read a VMware VM's runtime config, guest environment, or guest variable to inspect VM settings and guest OS state.

Instructions

Read a variable from the VM state.

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": {
      "var_type": "<var_type>",
      "name": "<name>"
    },
    "name": "vm_read_variable"
  }
}

Input Schema

Name	Required	Description
`vm`	No	VM name or .vmx path
`name`	Yes	Variable name to read
`var_type`	Yes	runtimeConfig: stored in .vmx file. guestVar: non-persistent runtime value. guestEnv: guest environment variable

Schema Changelog

Changes observed during successful MCP inspections.

First observedv0.2.0Aug 30, 2026

TDQS

B3.4/5.0

Behavior3/5

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

With no annotations, the description's verb 'Read' conveys the key non-mutating behavior, which is important for safe tool selection. It does not describe error cases, prerequisites, or return behavior, but for a read primitive the core behavior is clear.

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?

A single, front-loaded sentence with no filler. It is appropriately sized for a simple read tool.

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

Completeness4/5

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

For a three-parameter read tool with fully documented schema fields, the description plus schema supplies what an agent needs to invoke it. It could be more complete by naming the write counterpart and return value, but those are low-risk omissions.

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%; each parameter, especially var_type, has a meaningful description. The tool description itself adds no parameter detail, so the baseline 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?

States a clear action (read) on a clear resource (a variable from VM state), and the title reinforces it. It does not explicitly contrast with sibling vm_write_variable, so it stops short of full sibling differentiation.

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?

No guidance on when to choose this over alternatives; it does not mention vm_write_variable or other variable/guest-state tools. The only usage signal is implied by the verb 'read'.

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