Skip to main content
Glama

iaas_get_vsphere_storage_profile

Read-onlyIdempotent

Retrieves a vSphere storage profile (storage class) by ID from VCF Automation IaaS, returning its configuration details via the API.

Instructions

Get vSphere storage class Get vSphere storage class with a given id GET /iaas/api/storage-profiles-vsphere/{id}

Input Schema

NameRequiredDescriptionDefault
idYesThe ID of storage class. (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.4/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, idempotentHint=true and destructiveHint=false, so safety is covered. The description adds only the underlying REST path, and says nothing about what is returned, whether the id must reference a vSphere-specific profile, or behavior when the id does not exist.

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 text is short and front-loaded, but the first line is a truncated duplicate of the second, and the raw endpoint path largely repeats the URL already present in the annotation title. Every element is not earning its place.

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 simple read-only get-by-id tool with full schema coverage and complete annotations, this is close to sufficient — the agent knows it retrieves a single vSphere storage profile by identifier. The missing piece is explicit differentiation from sibling storage-profile getters.

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%, so both the 'id' and 'apiVersion' parameters are already documented in the schema, establishing the baseline of 3. The description's 'with a given id' only restates the required path parameter without adding format, source, or retrieval hints for obtaining it.

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 vSphere storage class with a given id') and the singular-by-id scope distinguishes it implicitly from the plural list sibling iaas_get_vsphere_storage_profiles. It does not explicitly name that sibling or the generic iaas_get_storage_profile, leaving the agent to infer the difference from naming.

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 a single-entity lookup, so usage is inferable, and the raw endpoint path reinforces that this is the GET-by-id route. However, there is no explicit statement of when to prefer this over iaas_get_storage_profiles or iaas_get_storage_profile, and no prerequisites or exclusions.

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