Skip to main content
Glama

approvals_get_approval_request_v3

Read-onlyIdempotent

Retrieve details of an approval request by UUID to review its status and related information in VCF Automation.

Instructions

Returns details of the approval request GET /approval/api/approvals/{id}

Input Schema

NameRequiredDescriptionDefault
idYesapproval request id (path)
apiVersionNoThe version of the API in yyyy-MM-dd format (UTC). For versioning information refer to /approval/api/about

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.2.0

TDQS

B3.2/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, idempotentHint=true, destructiveHint=false and openWorldHint=true, so the safety and side-effect profile is fully covered without the description. The description adds only the raw GET path, which restates the annotation title rather than adding behavioral context such as error behavior for missing/invalid ids; this is minimum viable given the annotation coverage.

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?

Two very short lines, front-loaded with the purpose, so the signal comes first. The second line duplicating the endpoint path is largely redundant with the annotation title but costs almost nothing.

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 tool the schema and annotations carry most of the burden, but with no output schema the description says nothing about what 'details' are returned or what the response shape looks like. It is adequate to call the tool but leaves the agent guessing about the return payload.

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%, with both 'id' (uuid, path) and 'apiVersion' (yyyy-MM-dd versioning) documented in the schema itself. The description adds no syntax or format guidance beyond what the schema provides, so the baseline of 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?

The description states a specific verb and resource ('Returns details of the approval request') and echoes the endpoint path, so the agent knows this is a single-record read. It does not distinguish itself from close siblings such as approvals_get_approval_requests_v3 (list) or approvals_get_work_item_by_id, leaving the agent to infer which one to pick.

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?

There is no explicit when-to-use or when-not-to-use guidance, and no alternatives are named despite several similar retrieval tools in the sibling list. The agent must infer usage purely from the fact that a single 'id' path parameter is required.

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