Skip to main content
Glama

ck_fs_read

Read-onlyIdempotent

Read files from the project root by path, with optional start line and max lines for windowed access. View file contents without modifying or creating anything.

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
pathYesFile or directory path relative to the project root.
max_linesNo
session_idNoUnique session identifier for correlating findings, proofs, budget, and audit trail.
start_lineNo1-indexed starting line number for partial file reads.
project_rootNoAbsolute path to the project root directory on the local filesystem.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
pathNo
contentNo
start_lineNo
total_linesNo
Behavior4/5

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

Annotations already declare readOnlyHint, idempotentHint, destructiveHint. The description reinforces with 'Read-only — no files are modified or created' and adds windowed read behavior. No contradiction. Adds context beyond annotations.

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?

Four sentences, front-loaded with purpose, no redundant words. Each sentence adds value.

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 output schema exists and annotations cover safety, the description covers usage, parameters, and alternatives well. Minor omission: no mention of error handling for missing paths or permissions, but overall complete.

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%; description adds meaning: path must be relative to project root, start_line is 1-indexed, max_lines enables windowed reads, omit both for full file. The schema lacks description for max_lines, so description compensates.

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 'Read a file from the bound project root' with clear verb and resource, and explicitly distinguishes from sibling tools (ck_fs_find, ck_fs_grep, ck_fs_ls).

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?

Provides explicit when-to-use guidance: 'Use ck_fs_read to inspect a file at a known path' and lists alternatives for locating, searching, and listing. Also explains when to use start_line/max_lines for windowed reads vs. omitting for full file.

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