Skip to main content
Glama

Cancel an audit

cancel_audit
Destructive

Stop a queued or running audit, after the user agrees, such as one launched by mistake or on the wrong engines. Runs at once and cannot be undone; answers recorded so far are kept, and no further prompt runs are spent on it. To launch a corrected audit use prepare_launch_audit. Refused if the audit is not in this project or has already finished.

Input Schema

NameRequiredDescriptionDefault
audit_idYesA queued or running audit id (audit_id) that read_visibility_overview or confirm_change returned.
project_idYesA project id that list_projects returned.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changed
    • addedInput schema / properties / audit_id / description
      Added value: +"A queued or running audit id (audit_id) that read_visibility_overview or confirm_change returned."
    • addedInput schema / properties / project_id / description
      Added value: +"A project id that list_projects returned."
  2. First observed

TDQS

A4.5/5.0
Behavior4/5

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

Annotations already declare destructive=true and non-idempotent, so the safety profile is partly covered; the description still adds substantial behavior: it runs immediately, is irreversible, preserves already-recorded answers, spends no further prompt runs, and lists the two refusal conditions. It stops short of describing auth/permission requirements or the response shape, which keeps it at a 4 rather than 5.

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 tight sentences: effect and precondition first, side effects second, routing alternative and refusal third. Every clause carries information an agent needs, with no filler.

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

Completeness5/5

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

For a two-parameter destructive action with no output schema, the description covers what gets stopped, what survives cancellation, what it costs, when it is refused, and which tool to use instead. An agent has everything required to invoke it correctly.

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% and both parameters are already documented in the schema, including that audit_id must be queued/running and where it comes from. The description repeats that constraint in prose but adds no new format or syntax detail, so the baseline 3 applies.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

Opens with a specific verb and resource ("Stop a queued or running audit") and immediately scopes it to the two valid lifecycle states. It explicitly names the sibling that handles the related-but-different job (prepare_launch_audit), so an agent can distinguish it without opening any schema.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Gives concrete when-to-use conditions ("after the user agrees", launched by mistake, wrong engines), an explicit alternative for the follow-up action (prepare_launch_audit), and a when-not clause ("Refused if the audit is not in this project or has already finished"). Nothing about selection is left to inference.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources