Skip to main content
Glama

List sessions

gameye_list_sessions
Read-onlyIdempotent

Lists game server sessions with host, ports, and connection strings, returning running sessions by default and optionally all statuses with label, image, host, location, or player-count filters.

Instructions

List game server sessions with host, ports and connection string. By default only running sessions are returned; pass all=true to include sessions in every status. filter and filterNot match user labels only (the labels given at launch), not system fields such as image or location — use the dedicated parameters for those. Values of the session's environment are never shown. Needs GAMEYE_API_TOKEN; without one, returns setup steps and sends nothing.

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": "gameye_list_sessions"
  }
}

Input Schema

NameRequiredDescriptionDefault
allNoInclude sessions in every status (default: running sessions only)
tagNoFilter by image tag/version
hostNoFilter by host IP
imageNoFilter by image name
filterNoOnly sessions whose user labels match every key=value pair
locationNoFilter by location/region
filterNotNoExclude sessions whose user labels match these key=value pairs
playerCountGtNoOnly sessions with more than N players
playerCountLtNoOnly sessions with fewer than N players

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.5.3

TDQS

A4.6/5.0
Behavior5/5

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

Beyond the annotations (readOnly/idempotent/non-destructive), it discloses two behaviors an agent cannot infer: environment values are never returned, and the tool requires GAMEYE_API_TOKEN — without it, it returns setup steps and performs no request. That auth-failure mode is exactly the kind of context annotations cannot carry.

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?

Four sentences, nothing wasted: purpose first, then default behavior, then the filtering caveat, then auth. Each sentence adds information not already carried by the schema or annotations, and the most load-bearing constraint is front-loaded.

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?

With nine optional parameters, no output schema, and nested objects, the description covers return fields, default scope, filter semantics, and auth failure. The only minor gap is that it does not mention result limits or pagination behavior for a list tool.

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, but the description adds real meaning by scoping filter/filterNot to launch-time user labels and explicitly excluding system fields like image or location, which prevents a plausible misuse of the nested object parameters.

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?

The first sentence gives a specific verb and resource ('List game server sessions') plus the returned fields (host, ports, connection string), which distinguishes it from the single-session describe tool by scope. An agent knows exactly what it gets back.

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?

Explicitly states the default scope (running only) and the switch to widen it (all=true), and warns that filter/filterNot operate on user labels only, directing agents to dedicated parameters for system fields. It stops short of naming a sibling tool as an alternative, so it is strong but not fully routing-aware.

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