Skip to main content
Glama

Remove a player from a relay session

edgegap_revoke_relay_user
DestructiveIdempotent

Revoke one player's access to a relay session, by that player's authorization token (from edgegap_get_relay_session or edgegap_authorize_relay_user). The player loses the relay connection; the session and the other players stay.

Instructions

Revoke one player's access to a relay session, by that player's authorization token (from edgegap_get_relay_session or edgegap_authorize_relay_user). The player loses the relay connection; the session and the other players stay.

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": {
      "session_id": "<session_id>",
      "user_authorization_token": "<user_authorization_token>"
    },
    "name": "edgegap_revoke_relay_user"
  }
}

Input Schema

NameRequiredDescriptionDefault
dry_runNoShow the exact request (method, host, path, body) with secrets masked, and send nothing. Local checks still run. Use it to confirm a billable or destructive call before making it.
session_idYesThe relay session_id, e.g. "0724828881e2-S".
user_authorization_tokenYesThe player's authorization token, not the session's.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv0.7.1

TDQS

A4.4/5.0
Behavior4/5

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

Annotations declare destructiveHint=true and idempotentHint=true, so the safety profile is largely covered. The description adds real context beyond that: the blast radius is scoped to a single player and the session plus other players survive, which prevents an agent from overestimating the destruction implied by destructiveHint. It does not cover auth requirements or behavior on an already-revoked/expired token.

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?

Two sentences, no filler. The action and scope come first, and the 'session and other players stay' clause is a compact, high-value carve-out rather than preamble.

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 3-parameter mutation with annotations and no output schema, the description is nearly sufficient: it gives action, token provenance, and effect. Remaining gaps are minor — no statement about return value or failure modes such as an unknown/expired token.

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 100%, so baseline is 3. The description goes beyond the schema by identifying where user_authorization_token comes from (get_relay_session or authorize_relay_user) and reinforcing that it belongs to the player, not the session — useful provenance the schema does not supply.

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: 'Revoke one player's access to a relay session.' It makes the granularity explicit (one player, not the whole session), which separates it from edgegap_delete_relay_session and edgegap_authorize_relay_user in the sibling list.

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?

Names the token source tools (edgegap_get_relay_session, edgegap_authorize_relay_user) and clarifies the effect: 'the session and the other players stay,' implicitly distinguishing this from tearing down a session. It stops short of stating explicit when-not conditions or edge cases (e.g. revoking the last player).

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