Skip to main content
Glama
feli0x

DocFS

by feli0x

read_files

Read files and retrieve their content as structured JSON, with support for multiple paths, line ranges, and encoding options.

Instructions

Reads content from one or more files and returns JSON data

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pathNoSingle file path to read (alternative to paths array)
pathsNoArray of file paths to read (maximum 10 files)
endLineNoEnding line number (1-based, optional)
encodingNoFile encoding (default: utf-8)utf-8
startLineNoStarting line number (1-based, optional)
maxFileSizeNoMaximum file size to read in bytes (default: 1MB)
showLineNumbersNoWhether to show line numbers (default: true)
Behavior3/5

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

With no annotations, the description carries the full burden. It clearly states the core behavior (reads files and returns JSON), implying a read-only operation. However, it does not disclose error handling, file size limits, or return format details, leaving some behavioral aspects undocumented.

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 a single, front-loaded sentence with no filler. It efficiently conveys the tool's purpose without unnecessary verbosity.

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

Completeness2/5

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

The tool has 7 parameters and no output schema. The description only says 'returns JSON data' without specifying the structure or fields returned. It also omits information about error behavior, line range handling, or multiple file output, which are relevant for a tool of this complexity.

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 coverage is 100%, so the baseline is 3. The description adds no parameter information beyond what the schema already provides. The mention of 'one or more files' is already captured by the path/paths properties.

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 the tool reads content from one or more files and returns JSON data. This specific verb (reads) and resource (files) clearly distinguishes it from sibling tools like list_files, search_files, and dir_tree.

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 guidance is provided on when to use this tool versus alternatives. It does not state that list_files is for listing file names, search_files for searching, etc., nor does it offer any context or exclusions.

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/feli0x/docfs'

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