Skip to main content
Glama

Delete check

delete_check
DestructiveIdempotent

Soft-delete a monitoring check by UID or slug to stop it immediately, resolve active incidents, remove scheduling jobs, and retain history. Deletion is permanent; disable instead to pause.

Instructions

Soft-delete a monitoring check by UID or slug. The check stops running immediately, its active incidents are resolved and its scheduling jobs removed; historical results are kept. A check that other checks tunnel through is refused. The deletion is permanent: there is no undelete, though it frees a slot in the MaxChecks quota. To stop a check without losing it, use update_check with enabled:false instead. Requires the mcp scope (mcp:read tokens are refused) and at least the user role in the organization.

Input Schema

NameRequiredDescriptionDefault
identifierYesCheck UID or URL-friendly slug, e.g. "api-prod" or "63d49e55-97e3-4e8c-b7ab-c862de7a43f3".

Output Schema

NameRequiredDescriptionDefault
deletedYesAlways true on success.
identifierYesThe UID or slug that was deleted.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changedv0.42.0
    • addedInput schema / properties / identifier / maxLength
      Added value: +2048
    • addedInput schema / properties / identifier / minLength
      Added value: +1
  2. Changed2 schema fields changedv0.41.0
    • addedInput schema / additionalProperties
      Added value: +false
    • addedOutput schema / additionalProperties
      Added value: +false
  3. Changed1 schema field changedv0.38.5
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "properties": {
      +    "deleted": {
      +      "description": "Always true on success.",
      +      "type": "boolean"
      +    },
      +    "identifier": {
      +      "description": "The UID or slug that was deleted.",
      +      "type": "string"
      +    }
      +  },
      +  "required": [
      +    "deleted",
      +    "identifier"
      +  ],
      +  "type": "object"
      +}
  4. First observedv0.32.1

TDQS

A4.7/5.0
Behavior5/5

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

Adds substantial context beyond the destructiveHint/idempotentHint annotations: immediate halt, active incidents resolved, scheduling jobs removed, historical results retained, permanence with no undelete, and freed MaxChecks quota. It also discloses auth requirements (mcp scope, mcp:read refused, user role required), which no annotation covers.

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?

The effect of the call is front-loaded, followed by side effects, the refusal case, permanence, and the alternative. Every sentence carries operational information; nothing is padding.

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?

With annotations covering the safety profile and an output schema covering the response, the description fills the remaining gaps: side effects, irreversibility, quota impact, permissions, and failure modes. Nothing an agent needs to decide or call correctly is missing.

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 coverage is 100% and the single parameter already documents UID-or-slug format with examples. The description's "by UID or slug" merely restates the schema, adding no new syntax or validation detail.

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?

States a specific verb and resource ("Soft-delete a monitoring check") plus the accepted identifier forms (UID or slug). It is clearly distinguishable from siblings such as get_check, update_check, and list_checks.

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?

Explicitly names the alternative and the condition that selects it: "To stop a check without losing it, use update_check with enabled:false instead." It also documents a refusal case (checks that other checks tunnel through), so an agent knows when this call will fail.

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