Skip to main content
Glama

ck_fs_read

Read file contents from a project root directory. Supports full or windowed reads using start line and max lines parameters. No modifications are made.

Instructions

Read a file from the bound project root. Read-only — no files are modified or created. path is required and must be relative to the project root (e.g., lib/my_module.ex). start_line (1-indexed) and max_lines enable windowed reads for large files. Omit both to read the entire file. Use ck_fs_read to inspect a file at a known path. Use ck_fs_find to locate a file by name fragment. Use ck_fs_grep to search inside files by content pattern. Use ck_fs_ls to list directory contents.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
max_linesNo
pathYesFile or directory path relative to the project root.
project_rootNoAbsolute path to the project root directory on the local filesystem.
session_idNoUnique session identifier for correlating findings, proofs, budget, and audit trail.
start_lineNo1-indexed starting line number for partial file reads.
Behavior5/5

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

No annotations provided, so description carries full burden. It clearly declares read-only behavior and that no files are modified or created. It also explains windowed reading capability. This is transparent and sufficient for an agent to understand side effects.

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 with no wasted words. It front-loads the main action, then provides specific details and alternatives. Every sentence serves a purpose, making it easy for an AI agent to parse quickly.

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 no output schema and moderate complexity (5 params, 1 required), the description fully covers what the tool does, how to use parameters, and when to use alternatives. It is complete enough for correct invocation without ambiguity.

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 80%, so baseline is 3. The description adds context beyond schema by explaining the purpose of start_line and max_lines for windowed reads and emphasizing that path must be relative. While some info repeats schema, the extra usage guidance justifies a 4.

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 it reads a file from the project root, is read-only, and distinguishes from siblings (ck_fs_find, ck_fs_grep, ck_fs_ls) by specifying when to use each. The verb 'read' and resource 'file' are specific, and the description covers key details like relative paths and windowed reads.

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 this tool ('inspect a file at a known path') and provides clear alternatives for other operations (locating files, searching content, listing directories). It also explains when to use start_line and max_lines for large files, giving clear usage context.

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/aryaminus/controlkeel'

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