Skip to main content
Glama

Read Guide Tool

read-guide
Read-onlyIdempotent

Read one Dadeland guide by id. Call list-guides first, then pass an id such as queries/smart-filters, functions, lander-go, modules/client/schema, index, glossary, or llms. Legacy names datasets, dashboards, data-load, queries, client-module, and reverse-etl still return that category's core guide.

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": {
      "guide": "<guide>"
    },
    "name": "read-guide"
  }
}

Input Schema

NameRequiredDescriptionDefault
guideYesGuide id or unique basename. Examples: queries/smart-filters, functions, lander-go, modules/client/schema, index, glossary, llms. Legacy: datasets, dashboards, data-load, queries, client-module, reverse-etl.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.9/5.0
Behavior3/5

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

Annotations already declare readOnlyHint and idempotentHint, so the safety profile is covered structurally. The description adds genuine non-obvious behavior in the legacy-name aliasing rule (datasets, dashboards, data-load, etc. return the category's core guide), which is real value beyond the annotations. It says nothing about the size or structure of the returned guide or error behavior for invalid ids.

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 sequencing in the first clause, with the alias list trailing. The long id enumeration duplicates the schema's example list, which is the one place wording could be trimmed.

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?

One required parameter, no nested objects, no output schema, and annotations covering read-only/idempotent behavior — so the description is nearly complete for this tool's complexity. The only missing piece an agent might want is any indication of what a guide read returns (size/format), but with no output schema expected, that omission is minor.

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 schema description already lists the same id examples and legacy aliases almost verbatim, so the description largely repeats structured data. The 'unique basename' notion is slightly clarified but the enumeration adds no meaning beyond the schema — 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 ('Read one Dadeland guide by id') with explicit single-item scope, and immediately distinguishes itself from its sibling by saying 'Call list-guides first' — an agent can select between the two without opening either schema.

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?

Gives a clear prerequisite workflow ('call list-guides first, then pass an id'), which is the main conditional an agent needs. It stops short of stating what happens with an unknown id or when a guide read would be inappropriate, so it is clear context rather than full when/when-not guidance.

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