Skip to main content
Glama

Canopy documentation

Read a guide

get_guide
Read-only

A docs page as markdown: for a dashboard guide, the menu path, the exact controls to click in order, and the reasons a control may be missing. Pass the guide URL or path from find_surface or list_surfaces, or a surface id such as console.roles.

Input Schema

NameRequiredDescriptionDefault
pageYesA docs URL, a /docs/... path, or a surface id.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.9/5.0
Behavior4/5

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

readOnlyHint=true already establishes the safety profile, so the description's job is to add behavioral detail — and it does, disclosing the response composition (menu path, ordered click steps, fallback explanations for absent controls). With no output schema present, this return-shape disclosure carries real weight; only error behavior for invalid pages is left unstated.

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?

Two sentences, front-loaded with the return contract before the input sourcing instruction. Nothing is redundant with the title or schema, and every clause carries information an agent would otherwise have to guess.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/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 no output schema, the definition covers what is returned, where the argument comes from, and the accepted identifier forms. Minor gaps remain around behavior on unknown surface ids or non-guide docs pages, but nothing essential to correct invocation 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%, so baseline would be 3, but the description adds value beyond the schema by showing a concrete surface-id example (console.roles) and naming the sibling tools that produce valid values. That clarifies accepted input forms and their origin in a way the schema's one-line property description does not.

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 concrete output contract — a docs page rendered as markdown containing menu path, ordered controls, and missing-control reasons — which tells an agent exactly what it gets back. It is distinguishable from find_surface and list_surfaces because it explicitly consumes their output as input, though it never contrasts itself with explain_capability, the closest conceptual sibling.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

It gives useful input-provenance guidance: pass the URL or path from find_surface or list_surfaces, which implies a discovery-then-read workflow. However, it never states when to use get_guide rather than explain_capability or search_api, and gives no exclusions or failure conditions, so usage is only implied.

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