Skip to main content
Glama

read_file

Read file contents from a specified path with configurable text encoding options for processing and automation workflows.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pathYes
encodingNoutf8

Implementation Reference

  • The execution handler for the 'read_file' MCP tool. Validates the file path existence, reads the file contents asynchronously using Node.js fs.promises.readFile, retrieves file statistics, and returns a structured response containing the text content and metadata including path, size, and encoding.
    async ({ path: filePath, encoding }) => {
      return wrapToolExecution(async () => {
        const validatedPath = await validatePathExists(filePath);
        const content = await fs.readFile(validatedPath, { encoding: encoding as FileEncoding });
        const stats = await fs.stat(validatedPath);
    
        return {
          content: [{ type: "text" as const, text: content }],
          metadata: {
            path: validatedPath,
            size: stats.size,
            encoding
          }
        };
      }, {
        errorCode: ERROR_CODES.FILE_OPERATION,
        context: "Failed to read file"
      });
    }
  • Zod input schema definition for the 'read_file' tool: 'path' is a required non-empty string, 'encoding' is an optional enum (utf8, utf-16le, latin1) defaulting to the configured default.
    {
      path: z.string().min(1, "Path is required"),
      encoding: z.enum(["utf8", "utf-16le", "latin1"]).optional().default(DEFAULTS.FILE_ENCODING)
    },
  • The registerReadFile function registers the 'read_file' tool on the MCP server instance using server.tool(), providing the name, Zod schema, and handler function.
    function registerReadFile(server: McpServer): void {
      server.tool("read_file",
        {
          path: z.string().min(1, "Path is required"),
          encoding: z.enum(["utf8", "utf-16le", "latin1"]).optional().default(DEFAULTS.FILE_ENCODING)
        },
        async ({ path: filePath, encoding }) => {
          return wrapToolExecution(async () => {
            const validatedPath = await validatePathExists(filePath);
            const content = await fs.readFile(validatedPath, { encoding: encoding as FileEncoding });
            const stats = await fs.stat(validatedPath);
    
            return {
              content: [{ type: "text" as const, text: content }],
              metadata: {
                path: validatedPath,
                size: stats.size,
                encoding
              }
            };
          }, {
            errorCode: ERROR_CODES.FILE_OPERATION,
            context: "Failed to read file"
          });
        }
      );
    }
  • src/index.ts:65-65 (registration)
    Higher-level registration call to registerFileTools(server), which internally calls registerReadFile to add the 'read_file' tool among file-related tools.
    registerFileTools(server);
Behavior1/5

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

Tool has no description.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness1/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Tool has no description.

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

Completeness1/5

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

Tool has no description.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters1/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Tool has no description.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose1/5

Does the description clearly state what the tool does and how it differs from similar tools?

Tool has no description.

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

Usage Guidelines1/5

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

Tool has no description.

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/ishuru/open-mcp'

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