Skip to main content
Glama

ping

Read-only

Verify that a Roblox Studio place is connected and responding, returning its name, PlaceId, and session ID so you can confirm connectivity before other calls or diagnose timeouts.

Instructions

Check that a Studio place is connected and answering, and return its name, PlaceId and session id. Read-only. Use it to confirm the plugin is connected before other calls, or to diagnose timeouts; list_places shows every connected place at once.

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

Input Schema

NameRequiredDescriptionDefault
placeNoTarget place (PlaceId or project name). Defaults to the bound/sole connected place.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4.4/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true and openWorldHint=false, so the safety profile is covered; the description's 'Read-only' line is mildly redundant. It earns credit for disclosing the concrete return fields and the diagnostic use case, though it says nothing about failure behavior (e.g., what a failed ping looks like).

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Two tight sentences, front-loaded with purpose and followed by usage and alternative. Dense but each clause carries information; only the 'Read-only' restatement is near-redundant with annotations.

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 simple one-optional-param connectivity check with no output schema, the description covers purpose, return fields, usage context, and the sibling alternative. Nothing an agent needs 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.

Parameters3/5

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

Schema coverage is 100% and the single optional 'place' parameter already documents 'PlaceId or project name' plus its default. The description adds no further parameter meaning, so the baseline 3 applies.

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 ('Check that a Studio place is connected and answering') and enumerates the return payload (name, PlaceId, session id). It also contrasts with a named sibling (list_places) so the agent can distinguish the two without opening schemas.

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 explicit when-to-use conditions: confirm the plugin is connected before other calls, or diagnose timeouts. It also names the alternative (list_places) and the condition that selects it (every connected place at once).

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