Skip to main content
Glama

Nopaque TotalPath

Get a UI Guide

getGuide
Read-onlyIdempotent

Get the full text of one guide or reference page by its slug from listGuides. For a guide, sections holds the steps in order: each names the page, menu, button or field to use in the web app, with extra detail about what it does. Use when: listGuides shows an entry that covers what the person wants to do. The steps are for a person using the web app to follow; this tool does none of them. An unknown slug returns 404.

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": {
      "slug": "<slug>"
    },
    "name": "getGuide"
  }
}

Input Schema

NameRequiredDescriptionDefault
slugYesA slug from the guide list.

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.5/5.0
Behavior4/5

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

Annotations already declare readOnly/idempotent/non-destructive, so the description correctly spends its words elsewhere: it explains that the returned steps are instructions for a human and that "this tool does none of them" — a crucial disclosure preventing an agent from treating the guide as an action executor. It also states the unknown-slug failure mode (404), which annotations do not cover.

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?

Front-loaded with the resource and return shape, then structure of sections, then usage trigger, then the human-instructions caveat and the error case. Every sentence carries distinct information; none restates the name or schema.

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 read tool with full annotation coverage and an output schema, this covers the remaining gaps: what the payload means (ordered sections), who the content is for, and how failure manifests. 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.

Parameters4/5

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

Schema coverage is 100% and there is only one parameter, so the baseline is already 3; the description adds provenance by tying the slug to listGuides, telling the agent where a valid value comes from rather than leaving it to guess. It does not add format or case-sensitivity detail, but the added meaning is real.

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 ("Get the full text of one guide or reference page") and anchors it to a sibling ("by its slug from listGuides"), so it is immediately distinguishable from listGuides. The one-line summary tells an agent exactly what comes 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 gives the when: "Use when: listGuides shows an entry that covers what the person wants to do," which names both the trigger and the prerequisite sibling. It does not spell out when-not to call (e.g. for a nonexistent slug) beyond the 404 note, but the routing guidance is clear.

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.