Skip to main content
Glama

Ler documento do handbook

read_handbook_doc

Read the full content of a handbook document by specifying its file path (e.g., 'deploy.md').

Instructions

Lê o conteúdo completo de um documento do handbook pelo seu id (o caminho relativo mostrado em list_handbook, ex: 'deploy.md').

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYesId do documento — caminho relativo, ex: 'ci-cd.md'.
Behavior3/5

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

No annotations provided, so description carries full burden. It states 'reads full content' but does not disclose any behavioral traits beyond that (e.g., return format, potential errors, or that it's a read-only operation). Adequate but not informative.

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 one sentence, clear, and front-loaded with the action. No wasted words.

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 no output schema, description lacks explicit return value format, but 'conteúdo completo' implies full document text. Overall adequate for a simple read tool.

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 description coverage is 100%, and description repeats the parameter info without adding new meaning. Baseline is 3; no extra value added.

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?

Description clearly states the tool reads the full content of a handbook document by its id, referencing sibling tool list_handbook for obtaining the id. It distinguishes itself from siblings (list_handbook lists, search_handbook searches).

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?

Description provides an example of id format and references list_handbook to get the id, implying use after listing. However, it does not explicitly state when to use this tool versus alternatives or when not to use it.

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/Joilson-Julkoski/scoutbook'

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