Skip to main content
Glama

get_doc_file

Read the full content of a documentation file by its relative path. Use offset and limit to paginate large files and avoid context limits.

Instructions

Read the full content of a specific documentation file by its relative path.

Use this tool when you know the exact file to read — typically after get_project_docs_overview or search_project_docs has identified the relevant file. It is read-only and has no side effects.

For large files, use offset and limit to read in chunks and avoid exceeding context limits. offset is a character (not line) position. Omit both to read the entire file.

Returns an error if the file does not exist or the path is outside the doc root.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
limitNoMax characters to return (default: entire file). Use together with offset to read in chunks.
offsetNoCharacter offset to start reading from (default: 0). Use for paginating large files.
relative_pathYesPath relative to the project doc root (e.g. "PRD.md" or "reports/weekly.md")
Behavior5/5

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

No annotations exist, so the description fully covers behavioral traits: declares read-only with 'no side effects,' explains chunking behavior, and documents error conditions (file not found or path out of bounds).

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 concise (5 sentences) with no filler. Purpose is front-loaded, usage guidance follows, and technical details are efficiently presented. Every sentence adds value.

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?

For a tool with 3 parameters and no output schema, the description covers all essential aspects: purpose, when to use, parameter semantics, chunking, and error handling. The agent has sufficient information to invoke the tool correctly.

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 100% with good descriptions, but the description adds crucial context: explains that offset is character-based, describes default behaviors, and clarifies the omit-to-read-entire-file pattern, going beyond what the schema provides.

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 starts with a clear verb+resource: 'Read the full content of a specific documentation file by its relative path.' It distinguishes itself from siblings like search_project_docs and get_project_docs_overview by focusing on reading a known file.

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 states when to use: 'when you know the exact file to read' and provides a typical workflow after using other tools. Also addresses large file handling with offset/limit, giving clear guidance on chunking.

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/epicsagas/alcove'

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