Skip to main content
Glama

Revoke a principal's access

revoke_principal
DestructiveIdempotent

Disable a principal to immediately invalidate its API key; this is irreversible, and erase=true hard-deletes the principal row instead of retaining it as disabled.

Instructions

Admin only. Disable a principal — its API key stops working immediately. Irreversible (create a new principal to restore access). With erase=True, the principal row is HARD-deleted (Art. 17 for team members) instead of retained as disabled. A tenant admin can only revoke its own tenant's principals; another tenant's id reads as unknown.

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": {
      "principal_id": "<principal_id>"
    },
    "name": "revoke_principal"
  }
}

Input Schema

NameRequiredDescriptionDefault
eraseNo
principal_idYes

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.11.0

TDQS

A4.7/5.0
Behavior5/5

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

Beyond the annotations (destructiveHint=true, idempotentHint=true), the description discloses that key invalidation is immediate, that disable is irreversible, that erase=True physically removes the row rather than retaining it disabled, and that cross-tenant ids behave as unknown. Those are exactly the consequences and authorization boundaries an agent needs before invoking a destructive call.

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?

Five short sentences, front-loaded with the 'Admin only' gate and the primary effect, then the irreversible warning, then the erase branch, then scoping. Every sentence changes what the agent would do; 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?

For a destructive, irreversible two-parameter tool this covers authorization scope, consequence, reversibility, and the meaning of the optional flag; an output schema exists so return values need not be described. Nothing needed to call it correctly is missing.

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

Parameters4/5

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

Schema coverage is 0% for two parameters, so the description carries the load; it fully explains the meaning and consequence of erase=True (hard delete vs retained disabled row). principal_id is only implicitly characterized through the tenant-scoping sentence — its expected format is never stated.

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 — 'Disable a principal' — plus the immediate effect ('its API key stops working immediately'). It also distinguishes the two modes of the tool (soft disable vs erase=True hard delete), so an agent knows exactly what operation it is choosing.

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

Usage Guidelines4/5

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

Clear activation context: admin-only, irreversible, use erase=True when GDPR Art. 17 erasure applies, and create a new principal if access must be restored. It stops short of explicitly naming an alternative sibling tool or a when-not-to-use case, but the decision criteria are unambiguous.

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