Skip to main content
Glama

read_full_guide

Retrieve the complete content of a guide by providing its guide ID. Ideal for getting full context for a short guide or implementing a feature from scratch.

Instructions

Get the complete content of a guide.

Use this tool when:

  • You need the full context of a guide

  • The guide is short and you want everything

  • You're implementing a feature from scratch

Warning: Large guides (>20k chars) will be truncated. Use consult_guide_for_task for specific sections.

Args: guide_id: Guide ID (e.g., 'python/fastapi-production')

Returns: Full guide content or table of contents if truncated

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
guide_idYes

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Behavior5/5

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

No annotations provided, so description carries full burden. It clearly discloses truncation behavior for large guides (>20k chars) and what is returned (full content or table of contents if truncated). No contradictions.

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?

Description is compact (8 lines) yet covers use cases, warnings, arguments, and returns. Structured with clear headings (Use this tool when:, Warning:, Args:, Returns:) making it easy to scan.

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?

Given one simple parameter and an output schema (implied), the description covers key behavioral aspects (truncation, return format). It is complete enough for effective tool selection and invocation.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters5/5

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

Schema coverage is 0% for descriptions, but the description adds meaning for the sole parameter 'guide_id' with an example ('python/fastapi-production'), which provides clear guidance beyond the schema's type definition.

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 clearly states 'Get the complete content of a guide.' Verb+resource is specific. While it doesn't explicitly differentiate from siblings like search_best_practices, the purpose is unambiguous and distinct from search functionality.

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?

Explicitly lists when to use (full context, short guide, implementing from scratch) and when not to (large guides, use consult_guide_for_task for sections). Provides clear context and alternatives.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/tripcher/canon'

If you have feedback or need assistance with the MCP directory API, please join our Discord server