Skip to main content
Glama
luciVuc

Shell MCP

by luciVuc

readFile

Read the entire contents of any text file as UTF-8. Use it to inspect configuration files, source code, or logs.

Instructions

Read the entire contents of a file and return it as UTF-8 text. Use this to inspect configuration files, source code, logs, or any text-based file. Returns the raw file content as a single text block. Throws an error if the file does not exist or cannot be read. Paths targeting sensitive system directories (e.g. /etc/shadow, /proc/, /dev/) are blocked.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pathYesAbsolute or relative path to the file to read. Relative paths are resolved from the server's working directory. Must not be empty or contain null bytes. Examples: `/home/user/config.json`, `./src/index.ts`, `../README.md`.
Behavior3/5

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

Discloses that it returns raw content as a single text block, throws errors on missing/unreadable files, and blocks sensitive paths. Lacks details on file size limits or behavior for binary files. No annotations provided, so description carries full burden.

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 concise sentences front-loaded with purpose and use cases. Every sentence adds value without redundancy. Efficiently structured.

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 simple file read tool, the description covers all essential aspects: purpose, usage, output format, error conditions, and blocked paths. No output schema exists, but return value is described. Lacks only minor details like encoding confirmation, but sufficient.

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 100% for the 'path' parameter. The description adds valuable guidance: relative path resolution, null byte prohibition, and examples, exceeding the schema's basic description.

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 verb (read), resource (file), and output format (UTF-8 text). It distinguishes from sibling tools like writeFile and deleteFile, indicating a read-only operation.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Provides clear use cases (inspect configuration files, source code, logs) and notes blocked paths for sensitive directories. Does not explicitly mention when not to use, but usage context is well-defined.

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/luciVuc/shell-mcp'

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