Skip to main content
Glama

Get Guide

get_guide
Read-onlyIdempotent

Read how to use PingRoom well, as Markdown: the PingRoom skill for clients that have none installed. Call it once before your first send. topic "overview" (the default) covers which tool to reach for, verifying the connection, every kind of Ping, questions, approvals, handoffs, live progress, errors and tone; topic "tools" is the full per-tool reference. Returns content, the topics you can ask for, and source (the skill's repository).

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

Input Schema

NameRequiredDescriptionDefault
topicNooverview: the skill (rules and recipes). tools: every tool's arguments and results.overview

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A4.4/5.0
Behavior4/5

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

Annotations already declare read-only, idempotent, closed-world, so the safety profile is covered; the description adds the useful context that the payload is Markdown and enumerates the return fields (content, available topics, source). It also previews the breadth of the overview topic, helping the agent gauge cost. Not a 5 because it doesn't indicate payload size or whether the two topics overlap in content.

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?

Front-loaded with purpose and the call-once rule, then the topic breakdown and return shape in one dense paragraph. Every clause carries information, though the long enumeration of overview subtopics makes the middle run on and could be tightened.

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 single-parameter documentation tool with an output schema present, nothing an agent needs is missing: when to call, which topic to pick, what each topic contains, and roughly what comes back. Return-value detail is correctly left to the output schema.

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% and the enum with its default is already documented in the schema, so the baseline is 3. The description exceeds that by expanding what each topic actually delivers — overview covers tool selection, connection verification, Ping kinds, questions, approvals, handoffs, progress, errors and tone, while tools is a full per-tool reference — which lets an agent pick without a trial call.

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 — read the PingRoom guide as Markdown — and frames it as the skill for clients with none installed, which cleanly separates it from every other sibling in the catalog. An agent knows immediately this is documentation retrieval, not a PingRoom operation.

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?

"Call it once before your first send" gives explicit timing and a de facto exclusion against repeated calls. It also routes within the tool by naming what each topic covers. Slightly short of a 5 because it never states what to do if the guide has already been read or what happens on a second call.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources