Skip to main content
Glama

iaas_get_internal_network_ip_range

Read-onlyIdempotent

Retrieve an internal IPAM network IP range by its ID from VCF Automation, so you can inspect its configuration and details for networking and address-planning tasks.

Instructions

Get internal IPAM network IP range Get internal IPAM network IP range with a given id GET /iaas/api/network-ip-ranges/{id}

Input Schema

NameRequiredDescriptionDefault
idYesThe ID of the network IP range. (path)
apiVersionNoThe version of the API in yyyy-MM-dd format (UTC). For versioning information refer to /iaas/api/about

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.2.0

TDQS

B3.1/5.0
Behavior2/5

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

Annotations already declare readOnlyHint, idempotentHint, openWorldHint and destructiveHint=false, so the safety profile is covered. The description adds only the raw HTTP path, saying nothing about error behavior when the id is unknown, permission requirements, or the shape of what comes back.

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

Conciseness3/5

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

The first two lines are near-duplicates ('Get internal IPAM network IP range' / 'Get internal IPAM network IP range with a given id'), and the third merely repeats the HTTP method and path already surfaced in the title and annotations. Short, but with visible redundancy.

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?

For a simple read-by-id with full schema coverage and explicit annotations, the description is adequate to the call. It nonetheless leaves out failure modes and any pointer to the list endpoint, so it is minimum viable rather than complete.

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 coverage is 100%, including the apiVersion description, so the schema carries all parameter meaning. The description only restates that an id is required, with no added format or sourcing guidance.

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 and resource ('Get internal IPAM network IP range') and the second line clarifies it returns the single range for a given id, which implicitly distinguishes it from iaas_get_internal_network_ip_ranges. No explicit sibling naming, but the resource is unambiguous.

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?

'with a given id' implies the single-item retrieval case, so usage is reasonably implied. There is no explicit when-to-use/when-not statement or reference to the plural list tool as an alternative.

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