Skip to main content
Glama

desk_revoke_api_key

Destructive

Revokes an API key at once; with cascade it also revokes every key that key issued.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "key_id": "<key_id>"
    },
    "name": "desk_revoke_api_key"
  }
}

Input Schema

NameRequiredDescriptionDefault
key_idYesAPI key UUID
cascadeNotrue to also revoke every key this key issued (use when a key leaked)
purposeNoRequired on tools that read data or reports; recommended on every tool. One sentence: what you are doing and why (for example "finding this caller's open ticket to answer them"). Building a report, dashboard, analytics or an export is a SautiDesk Pro feature done by the report tools, not by pulling records.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.8/5.0
Behavior4/5

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

Annotations already declare destructiveHint=true, so the bar is lower; the description adds real value by disclosing that revocation happens immediately ('at once') and defining the blast radius of cascade — every key issued by the target. It stops short of saying the action is irreversible or what happens to live credentials.

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?

A single sentence, front-loaded with the core action and then the optional branch. Nothing is padded or repeated.

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

Completeness4/5

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

For a three-parameter destructive tool with no output schema and full annotation coverage, this covers the essentials: immediate effect and cascade scope. Only irreversibility and post-revocation consequences are unaddressed.

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 cascade description already explains 'true to also revoke every key this key issued (use when a key leaked)', so the description largely restates the schema. Baseline 3 is appropriate when the schema carries the parameter meaning.

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 and resource ('Revokes an API key') and adds scope with the cascade clause. It is distinguishable from desk_create_api_key / desk_list_api_keys by being the destructive counterpart, though it never names a sibling or alternative.

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

Usage Guidelines3/5

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

The cascade clause implies the situation in which it is needed, and the schema goes further ('use when a key leaked'), but the description itself gives no explicit when-to-use/when-not guidance, no prerequisites, and no note about verifying the key first.

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