Skip to main content
Glama

List relay sessions

edgegap_list_relay_sessions
Read-only

List active relay sessions with ID, status, readiness, and player count to identify leftover sessions that still bill, then delete them via edgegap_delete_relay_session.

Instructions

List this organization's active relay sessions: id, status, readiness and player count. Relay sessions bill while open, so use this to find ones left over from earlier sessions and delete them with edgegap_delete_relay_session. Authorization tokens are not listed; read one session with edgegap_get_relay_session.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "edgegap_list_relay_sessions"
  }
}

Input Schema

NameRequiredDescriptionDefault

No arguments

Output Schema

NameRequiredDescriptionDefault
totalNo
showingNo
sessionsNo
next_stepNo
truncatedNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv0.12.0
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "$schema": "http://json-schema.org/draft-07/schema#",
      +  "additionalProperties": {},
      +  "properties": {
      +    "next_step": {
      +      "type": "string"
      +    },
      +    "sessions": {
      +      "items": {
      +        "additionalProperties": {},
      +        "properties": {
      +          "error": {
      +            "type": "string"
      +          },
      +          "linked": {
      +            "type": "boolean"
      +          },
      +          "players": {
      +            "type": "number"
      +          },
      +          "ready": {
      +            "type": "boolean"
      +          },
      +          "relay": {
      +            "type": "string"
      +          },
      +          "session_id": {
      +            "type": "string"
      +          },
      +          "status": {
      +            "type": "string"
      +          }
      +        },
      +        "type": "object"
      +      },
      +      "type": "array"
      +    },
      +    "showing": {
      +      "type": "number"
      +    },
      +    "total": {
      +      "type": "number"
      +    },
      +    "truncated": {
      +      "type": "boolean"
      +    }
      +  },
      +  "type": "object"
      +}
  2. Addedv0.7.1

TDQS

A4.9/5.0
Behavior5/5

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

Annotations already declare readOnlyHint and openWorldHint, but the description adds genuinely new behavioral context: relay sessions bill while open, so this listing has a cost-control purpose. It also discloses a coverage limit — authorization tokens are not listed — which an agent would otherwise wrongly assume.

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 short sentences with no filler: the summary, the cost-driven motivation with the next action, and the limitation with the alternative. The most actionable information (what is returned) is front-loaded.

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?

Zero parameters, an output schema that covers the return shape, and annotations covering the safety profile mean the description only needs to supply motivation, follow-up, and limitations — all of which it does. Nothing an agent needs to call this 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?

The tool takes zero parameters, so there is nothing for the description to disambiguate and the baseline is 4. The description uses that space to describe the listed fields instead, which the output schema already covers, so no credit above baseline.

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 ("List this organization's active relay sessions") and even names the fields surfaced (id, status, readiness, player count), so what it returns is unambiguous. It is clearly distinguishable from the sibling edgegap_get_relay_session, which it explicitly routes single-session reads to.

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 an explicit use case (find leftover sessions from earlier runs because sessions bill while open) and names the follow-up action with edgegap_delete_relay_session, plus the alternative edgegap_get_relay_session for reading one session. When-to-use, what-to-do-next, and the alternative are all spelled out.

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