Skip to main content
Glama

read_docs

Read-only

Read Charming documentation without web access. Call without arguments to get the docs index, then pass a page path from that index (for example capabilities/data-storage.md). Use this when building an app or looking up the runtime, API, or capability reference. Returns Markdown in chunks of up to 20,000 characters; pass next_offset as offset with the same path to continue. For the full authoring reference, use llms-full.txt. Only public Charming docs can be read. Limited to 60 reads per caller per minute.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pathNoPath relative to /docs/, such as capabilities/data-storage.md or llms-full.txt. A copied docs/ prefix is accepted. Omitted or empty paths default to llms.txt (the docs index). Page slugs without .md also work. No full URLs, query strings, or fragments.
offsetNoCharacter offset returned as next_offset by the prior read. Defaults to 0.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
urlYes
pathYes
markdownYes
next_offsetYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A4.9/5.0
Behavior5/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 adds substantial behavioral details beyond annotations: pagination via offset (chunks of up to 20,000 characters), default to llms.txt when path is omitted, acceptance of paths without .md, rejection of URLs/query strings/fragments, and rate limiting. No contradiction exists.

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?

The description is structured efficiently: it starts with the primary purpose and usage flow, then goes into when to use it, return format, limitations, and alternatives. Every sentence adds critical information—no filler. Information is front-loaded so an agent quickly grasps how to call it correctly.

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 the tool's simplicity (read-only, 2 params, output schema exists), the description is fully complete. It covers the invocation flow, pagination mechanics, accepted inputs, exclusions, and rate limits. With annotations covering safety and an output schema handling return values, nothing an agent needs is missing.

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 description coverage is 100% and the schema itself provides detailed descriptions for both 'path' and 'offset'. The description adds valuable semantics: the default path when omitted (llms.txt), that a 'docs/' prefix is accepted, that slugs without .md work, and that offset should be taken from prior next_offset. This goes beyond the schema, though the schema already covers the basics, so it earns a 4 rather than 5.

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 states a specific verb ('Read') and resource ('Charming documentation') with a clear scope: 'without web access'. It also mentions the intended use cases ('building an app or looking up the runtime, API, or capability reference'), which differentiates it from all sibling tools—no other tool reads documentation. This makes the purpose unambiguous.

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?

It provides explicit usage guidance: call without arguments to get the index, then pass a page path from that index. It names an alternative for a specific need ('For the full authoring reference, use llms-full.txt'), implying when not to use this tool. It also states limitations like 'Only public Charming docs can be read' and 'Limited to 60 reads per caller per minute', giving clear boundaries.

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.