read_file
Read file contents from a specified path with configurable encoding options for text processing workflows.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| path | Yes | ||
| encoding | No | utf8 |
Implementation Reference
- src/tools/file-tools.ts:32-50 (handler)The handler function for the read_file tool. It validates the file path, reads the file contents using Node.js fs.readFile, retrieves file stats, and returns the content as a text block along with metadata (path, size, encoding). Uses error wrapping for safety.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/tools/file-tools.ts:28-31 (schema)Zod schema defining input parameters for the read_file tool: 'path' (required string) and 'encoding' (optional enum: utf8, utf-16le, latin1; defaults to DEFAULTS.FILE_ENCODING).{ path: z.string().min(1, "Path is required"), encoding: z.enum(["utf8", "utf-16le", "latin1"]).optional().default(DEFAULTS.FILE_ENCODING) },
- src/tools/file-tools.ts:26-52 (registration)Registers the read_file tool on the MCP server using server.tool(), providing the tool name, input schema, and handler function. This is called from registerFileTools.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)Top-level registration call in main server initialization that invokes registerFileTools, thereby registering the read_file tool among file tools.registerFileTools(server);