Skip to main content
Glama

blueprint_cancel_blueprint_request

Cancels an in-progress blueprint request using its request ID to stop further processing in VCF Automation.

Instructions

Cancel request POST /blueprint/api/blueprint-requests/{requestId}/actions/cancel

Input Schema

NameRequiredDescriptionDefault
requestIdYes(path)
apiVersionNoThe version of the API in yyyy-MM-dd format (UTC). For versioning information please refer to /blueprint/api/about

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.2.0

TDQS

C2.9/5.0
Behavior2/5

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

The annotations already declare readOnlyHint=false, openWorldHint=true, idempotentHint=false, and destructiveHint=false, so the safety profile is largely covered. The description adds only the HTTP endpoint and does not explain the effect of cancellation, whether it is asynchronous, what state the request enters, or any auth requirements.

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?

The description is very short and front-loads the action before the endpoint, with no wasted prose. It is slightly under-specified rather than verbose, but structurally it is efficient.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a mutation action with no output schema, the description should explain what cancellation actually does and any conditions around it. It leaves the agent with only the endpoint and verb, which is not enough to understand the operation's consequences or edge cases.

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 requestId and apiVersion are already documented in the input schema. The description adds no parameter meaning, but the baseline is 3 when the schema fully carries parameter documentation.

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 clear verb, 'Cancel', and the endpoint path ties it to blueprint request cancellation. It does not explicitly distinguish this action from sibling tools like blueprint_delete_blueprint_request or blueprint_get_blueprint_request, but the core purpose is identifiable.

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 guidance on when to use this tool versus alternatives, no prerequisites, and no note about when a blueprint request is cancellable. The agent can infer it is for cancellation, but nothing tells it whether to choose cancel over delete or another request-management tool.

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