Skip to main content
Glama

FFxF

Get machine network

get_vm_network
Read-only

IPv4 and IPv6 addresses of a machine with their reverse DNS, and its private networks. Scope: vms.read.

Input Schema

NameRequiredDescriptionDefault
vmYesMachine id, as returned by list_vms or create_vm.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.5/5.0
Behavior3/5

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

The annotations already declare a safe, read-only operation (readOnlyHint=true, openWorldHint=true), so the safety profile is covered. The description adds the required permission scope (vms.read) and specifies exactly what data is returned. It does not describe error behavior for unknown or inaccessible VM ids.

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?

One short sentence plus a scope clause, both front-loaded with zero filler. The only minor cost is that the fragmentary phrasing reads like a return-type list rather than a complete statement of action.

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?

No output schema exists, so the description usefully enumerates the return contents (IPv4/IPv6, reverse DNS, private networks) and states the auth scope. For a single-parameter read tool this is nearly sufficient; only error/empty-case behavior is left unstated.

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%, and the single 'vm' parameter is documented as a machine id returned by list_vms or create_vm. The description adds nothing about the parameter, so baseline 3 is appropriate when the schema carries the full burden.

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 names the specific resource and its contents: IPv4/IPv6 addresses with reverse DNS plus private networks. It distinguishes itself implicitly from the sibling get_vm by focusing on network data. The only weakness is that it is a noun phrase with no verb, so the action must be inferred from the get_ prefix.

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?

The usage is implied by the content (fetch network details for a known machine), and 'Scope: vms.read' signals the permission context. However, there is no explicit when-to-use statement, no exclusions, and no reference to alternatives such as get_vm or get_firewall.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources