Skip to main content
Glama
Sign In
truenas-ws-mcp

truenas-ws-mcp

by thoriphes
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Python
Remote

update_vm

Update VM configuration including RAM and CPU allocation. Changes require a full stop and start from TrueNAS to take effect.

Instructions

Update VM configuration (RAM, CPUs, etc.).

Note: RAM/CPU changes only take effect after a full stop+start from TrueNAS — rebooting from inside the VM does NOT re-allocate resources.

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>",
      "settings": "<settings>"
    },
    "name": "update_vm"
  }
}

Input Schema

NameRequiredDescriptionDefault
vm_idYes
settingsYes

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.1

TDQS

A3.8/5.0
Behavior4/5

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

Discloses important behavioral detail that RAM/CPU changes only take effect after full stop+start, not reboot. No annotations exist, so description carries full burden; it satisfies with key behavioral nuance.

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 sentences front-loaded with purpose and a critical note. No fluff, every word earns its place.

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?

Adequate for a simple update tool, but lacks detail on the settings object parameters and return value. Output schema exists but is not referenced.

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?

Description only vaguely mentions RAM and CPUs, but does not specify exact keys, structure, or allowable values for the 'settings' object. With 0% schema description coverage, more detail is needed.

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?

Clear verb 'Update' and specific resource 'VM configuration' with examples (RAM, CPUs). Distinct from sibling tools as there is no other update VM tool among siblings.

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?

Provides a critical post-update instruction (stop+start needed, not reboot), but lacks explicit guidance on when to use this tool vs alternatives or prerequisites.

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