Skip to main content
Glama

ck_fs_read

Read-onlyIdempotent

Read a file from the project root by its relative path. Supports full file reads or windowed reads by specifying start line and max lines.

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.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
contentNo
pathNo
start_lineNo
total_linesNo
Behavior4/5

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

Annotations already declare readOnlyHint=true, destructiveHint=false, idempotentHint=true. The description reinforces these and adds details about windowed reads with start_line and max_lines. However, it does not mention error behavior or other edge cases, which would push it to 5.

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 paragraph of about 60 words, front-loading the main purpose. Every sentence adds value, and there is no redundancy.

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

Completeness4/5

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

Given that parameters are mostly documented in the schema and an output schema exists, the description is reasonably complete. It covers purpose, usage, and sibling differentiation. It does not explain session_id or project_root, but those are in the schema. Minor gap: no discussion of error handling.

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 80% (4 of 5 parameters described). The description adds value beyond schema by explaining that path must be relative to the project root (with example), that start_line is 1-indexed, and that max_lines enables windowed reads. It compensates for the missing schema description of max_lines.

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 a file from the project root, specifies it is read-only, and distinguishes it from sibling tools (ck_fs_find, ck_fs_grep, ck_fs_ls) by naming them and their specific use cases.

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 tells when to use this tool ('inspect a file at a known path') and when to use alternatives (find, grep, ls), providing clear context for the AI agent.

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