Skip to main content
Glama

Nopaque TotalPath

List UI Guides

listGuides
Read-onlyIdempotent

List the step-by-step guides to the nopaque web app, and the reference pages (pricing, FAQ). Each entry has a slug, a kind (guide or reference), a group, a title and a one-line summary. Use when: someone asks how to do, set up or configure something in the web app, or what something costs, and you need to know whether a guide covers it. Pass a slug to getGuide for the full text. If no entry covers the question, there is no guide for it: say so rather than guessing at screens. The same for every workspace.

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

Input Schema

NameRequiredDescriptionDefault

No arguments

Output Schema

NameRequiredDescriptionDefault
guidesYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.6/5.0
Behavior4/5

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

Annotations already declare readOnly, idempotent, closed-world and non-destructive, so the safety profile is covered. The description adds real behavior beyond that: the fields each entry carries, the handoff to getGuide, and an explicit instruction not to fabricate UI steps when no entry matches. The closing 'The same for every workspace' is too terse to be informative, which keeps this from a 5.

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?

It is front-loaded: what it lists first, then when to use it, then the escalation path, then the empty-result rule. Every sentence except the trailing 'The same for every workspace' carries actionable meaning; that fragment is ambiguous and slightly dilutes an otherwise tight definition.

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 an output schema present, the description needn't spell out return values, yet it still summarizes the entry fields. Combined with the usage trigger, the getGuide handoff, and the no-match guidance, an agent has everything needed to call this correctly and interpret an empty list.

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?

The tool takes zero parameters, so the baseline is 4. The description's mention of 'slug' refers to a field of the returned entries and to the input of getGuide, not to a parameter here, so there is nothing further to clarify.

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 description opens with a specific verb and resource: listing step-by-step guides and reference pages (pricing, FAQ) for the nopaque web app. It also enumerates the entry shape (slug, kind, group, title, one-line summary), so an agent knows exactly what this returns versus what getGuide returns.

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?

It gives an explicit trigger ('someone asks how to do, set up or configure something... or what something costs'), names the follow-up alternative ('Pass a slug to getGuide for the full text'), and defines the negative case ('If no entry covers the question, there is no guide for it: say so rather than guessing at screens'). When-to-use, what-to-do-next, and the no-result fallback are all covered.

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.