Skip to main content
Glama

Describe session

gameye_describe_session
Read-onlyIdempotent

Retrieve Gameye session status, players, host, ports, connection string, labels, and creation time to inspect or troubleshoot multiplayer servers. Requires API token; environment values stay hidden.

Instructions

Get details of a Gameye session: status, players, host, ports, connection string, labels and creation time. Values of the session's environment are never shown. Needs GAMEYE_API_TOKEN; without one, returns setup steps and sends nothing.

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": {
      "id": "<id>"
    },
    "name": "gameye_describe_session"
  }
}

Input Schema

NameRequiredDescriptionDefault
idYesSession ID to describe

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.5.3

TDQS

A4.3/5.0
Behavior5/5

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

Beyond the annotations (readOnly, idempotent, non-destructive), the description adds two pieces of behavior an agent could not infer: environment values are never returned, and a missing token causes setup steps to be returned with nothing sent. The latter is a meaningful side-effect disclosure that prevents misinterpretation of a failure response.

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, front-loaded with purpose and return fields, followed by two behavioral caveats. No filler, no restatement of the title, and every sentence carries information an agent needs.

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?

With no output schema, the description compensates by enumerating the returned fields, and it covers the auth failure mode and the deliberate exclusion of environment values. For a single-parameter read tool this is complete enough to call correctly and to interpret the response.

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?

There is a single parameter with 100% schema coverage ('Session ID to describe'), so the schema already carries the semantics. The description adds nothing about ID format or where to obtain the ID, which is the minimum-viable baseline for a fully documented single parameter.

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?

The description opens with a specific verb and resource ('Get details of a Gameye session') and enumerates exactly what is returned: status, players, host, ports, connection string, labels, creation time. That distinguishes it in practice from list-style siblings, but it never names the alternative (e.g. gameye_list_sessions) so the routing is implied rather than stated.

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?

Usage context is clear: this is the per-session lookup, and the auth precondition ('Needs GAMEYE_API_TOKEN') plus the no-token fallback behavior are explicitly stated. There is no explicit when-not guidance or named alternative, which keeps it out of 5 territory.

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