Skip to main content
Glama

write_file

Write content to files with options for encoding, directory creation, overwriting, and backups.

Instructions

Write content to a file

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pathYesPath to write to
contentYesContent to write
encodingNoFile encoding (default: utf-8)
create_dirsNoCreate parent directories
overwriteNoOverwrite if exists
backupNoCreate backup before overwrite

Implementation Reference

  • Implementation of the logic for writing to a file, handling existence checks, backups, directory creation, and error handling.
    async function writeFileImpl(input: WriteFileInput): Promise<ToolResult> {
      try {
        const absolutePath = path.resolve(input.path);
    
        // Check if file exists
        let exists = false;
        try {
          await fs.access(absolutePath);
          exists = true;
        } catch {
          // File doesn't exist
        }
    
        // Handle overwrite logic
        if (exists && !input.overwrite) {
          return {
            isError: true,
            content: [
              {
                type: 'text',
                text: JSON.stringify({
                  code: 'ALREADY_EXISTS',
                  message: `File already exists and overwrite is false: ${input.path}`,
                }),
              },
            ],
          };
        }
    
        // Create backup if requested
        if (exists && input.backup) {
          const backupPath = `${absolutePath}.bak`;
          await fs.copyFile(absolutePath, backupPath);
        }
    
        // Create parent directories if requested
        if (input.create_dirs) {
          const dir = path.dirname(absolutePath);
          await fs.mkdir(dir, { recursive: true });
        }
    
        // Write the file
        await fs.writeFile(absolutePath, input.content, {
          encoding: input.encoding as BufferEncoding,
        });
    
        return {
          content: [
            {
              type: 'text',
              text: JSON.stringify({
                success: true,
                path: absolutePath,
                bytes_written: Buffer.byteLength(input.content, input.encoding as BufferEncoding),
              }),
            },
          ],
        };
      } catch (error) {
        const err = error as NodeJS.ErrnoException;
    
        if (err.code === 'EACCES') {
          return {
            isError: true,
            content: [
              {
                type: 'text',
                text: JSON.stringify({
                  code: 'PERMISSION_DENIED',
                  message: `Permission denied: ${input.path}`,
                }),
              },
            ],
          };
        }
    
        return {
          isError: true,
          content: [
            {
              type: 'text',
              text: JSON.stringify({
                code: 'UNKNOWN_ERROR',
                message: `Error writing file: ${err.message}`,
              }),
            },
          ],
        };
      }
    }
  • Registration of the 'write_file' tool with the MCP server, including the tool schema definition and the handler call.
    // write_file tool
    server.tool(
      'write_file',
      'Write content to a file',
      {
        path: z.string().describe('Path to write to'),
        content: z.string().describe('Content to write'),
        encoding: z.string().optional().describe('File encoding (default: utf-8)'),
        create_dirs: z.boolean().optional().describe('Create parent directories'),
        overwrite: z.boolean().optional().describe('Overwrite if exists'),
        backup: z.boolean().optional().describe('Create backup before overwrite'),
      },
      async (args) => {
        const input = WriteFileInputSchema.parse(args);
        return await writeFileImpl(input);
      }
    );
Behavior2/5

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

No annotations are provided, so the description carries full burden. 'Write content to a file' implies a mutation operation but lacks details on permissions, side effects (e.g., overwriting), error handling, or performance. This is inadequate for a tool with potential destructive behavior.

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, efficient sentence with zero wasted words. It's front-loaded and directly communicates the core function without unnecessary elaboration, making it highly concise.

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

Completeness2/5

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

For a mutation tool with no annotations and no output schema, the description is insufficient. It doesn't address behavioral traits like overwriting implications, error cases, or return values, leaving critical gaps for safe and effective use.

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

Parameters3/5

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

Schema description coverage is 100%, so parameters are well-documented in the schema. The description adds no additional semantic context beyond the basic action, meeting the baseline for high schema coverage without compensating value.

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

Purpose4/5

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

The description 'Write content to a file' clearly states the verb ('write') and resource ('file'), making the purpose immediately understandable. However, it doesn't differentiate from sibling tools like 'copy_file' or 'move_file' that also involve file operations, missing explicit distinction.

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

Usage Guidelines2/5

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

The description provides no guidance on when to use this tool versus alternatives. With siblings like 'copy_file', 'move_file', and 'read_file', there's no indication of use cases, prerequisites, or exclusions, leaving the agent to infer usage.

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/mcp-tool-shop-org/mcp-file-forge'

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