Skip to main content
Glama

skypilot_api_cancel

Destructive

Cancel pending SkyPilot API requests by providing request_ids for specific tasks or all_users to cancel across users. Returns a request_id for the cancellation operation.

Instructions

Cancel pending API requests. Specify request_ids to cancel specific requests. Returns a request_id for the cancel operation itself.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
all_usersNo
request_idsNo

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

B3.1/5.0
Behavior3/5

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

Annotations indicate destructiveHint=true, so the agent knows this is a destructive operation. The description adds that it returns a request_id for the cancel operation itself, which is useful context beyond the annotations. However, it doesn't explain what happens to the canceled requests, whether cancellation is immediate, or any side effects. With annotations covering the destructive nature, a 3 is appropriate.

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

Conciseness5/5

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

Three short sentences, front-loaded with the core action. Every sentence contributes useful information: action, parameter usage, and return behavior.

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?

The tool has two parameters, one undocumented, and an output schema exists so return values needn't be explained. The description covers the main action and return id but neglects the all_users parameter and lacks guidance on when to use this versus other cancel tools. Adequate but with clear gaps.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters2/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 0%, so the description must compensate, but it only mentions request_ids and says nothing about the all_users parameter. This leaves one parameter completely undocumented, failing to meet the low-coverage 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?

States a specific verb+resource: 'cancel pending API requests', which clearly distinguishes it from siblings like skypilot_job_cancel or skypilot_managed_job_cancel. However, it doesn't explicitly differentiate from those cancel siblings or from skypilot_api_stop (which might also cancel server operations). Still, the focus on 'API requests' is reasonably clear.

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?

The description says to specify request_ids to cancel specific requests, but gives no guidance on when to use this tool versus skypilot_api_stop, skypilot_job_cancel, or skypilot_managed_job_cancel. No when-not conditions or alternatives are mentioned.

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