Skip to main content
Glama

read_doc

Retrieves the full contents of a named .md documentation file so agents can inspect LangLa wire messages, ports, and packet field ordering without guessing.

Instructions

Đọc toàn bộ một file docs (vd. CLIENT_STATS_LONG.md hoặc CLIENT_STATS_LONG).

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
nameYesTên file .md trong docs/

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.0

TDQS

B3.4/5.0
Behavior3/5

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

No annotations are provided, so the description carries the burden. It discloses one behavioral trait beyond the schema: the whole file is returned ('toàn bộ'), implying no truncation. It says nothing about missing-file behavior or response shape.

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?

A single short sentence, front-loaded with the action and scope, with examples in parentheses. No waste.

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

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a one-parameter read tool with no output schema, the definition is adequate but leaves the return representation and failure mode unspecified; an agent knows what to pass but not quite what to expect.

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 already 100%, but the description adds real value: the example shows the extension may be omitted (CLIENT_STATS_LONG.md or CLIENT_STATS_LONG), which the schema's '.md file name' wording does not communicate.

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 and resource: read the ENTIRE docs file, with concrete examples (CLIENT_STATS_LONG.md). It is clearly distinguishable from list_docs/search_docs because of the whole-file scope, but it never names a sibling to make the boundary explicit.

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

Usage Guidelines2/5

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

No statement of when to use this instead of list_docs or search_docs. The examples hint at accepted filename forms but give no routing guidance or preconditions.

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

Deploy Server

Other Tools