Skip to main content
Glama

Guides Read

guides_read
Read-only

Read the interview guide stored on a project. The guide has an intro, ordered blocks (title, minutes, questions, notes), total time, a notes template, and any markdown that did not parse. Returns an empty guide when the project has none.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
project_idYesProject UUID.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A3.7/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true and destructiveHint=false, so the safety profile is covered. The description goes beyond that by disclosing the structure of the returned guide (intro, ordered blocks with title/minutes/questions/notes, total time, notes template, unparsed markdown) and the empty-guide edge case, which is genuinely useful behavioral context for a no-output-schema tool.

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?

Three short sentences, front-loaded with the action and then the return shape, with no filler. The list of guide components is dense but each element is informative; nothing reads as padding.

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?

With only one fully documented parameter, no output schema, and read-only annotations, the remaining burden is describing the return value, which the description does at a structural level and even covers the missing-guide case. An agent has enough to invoke and interpret it correctly.

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 project_id is documented as a Project UUID, so the schema carries the parameter burden. The description's phrase 'stored on a project' loosely reinforces the project scope but adds no format or constraint detail beyond the schema, making the baseline 3 correct.

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?

States a specific verb (read) and resource (the interview guide stored on a project), which clearly separates it from guides_create and guides_edit among its siblings. It stops short of explicitly naming those alternatives, but the read/write split is unambiguous from the verb.

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?

Usage is implied by the resource ('read the interview guide stored on a project') and the empty-guide fallback tells the agent what to expect, but there is no explicit statement of when to call this instead of, say, interviews_read or guides_edit. No prerequisites or exclusions are given.

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