Skip to main content
Glama

quick_replace

Find and replace text in files using literal string matching. Replace all occurrences or just the first instance without regular expressions.

Instructions

Simple find and replace across a file without regex

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
fileYesFile to edit
findYesText to find (literal, not regex)
replaceYesText to replace with
allNoReplace all occurrences (false = first only)

Implementation Reference

  • Handler function for 'quick_replace' tool. Validates input file existence, escapes find and replace strings to treat them literally (no regex), constructs sed command for replacement (all or first occurrence), executes it with backup, and returns success message.
    case 'quick_replace': {
      const { file, find, replace, all = true } = args;
      
      if (!existsSync(file)) {
        throw new Error(`File not found: ${file}`);
      }
      
      // Escape special characters for sed
      const escapedFind = find.replace(/[.*+?^${}()|[\]\\]/g, '\\$&');
      const escapedReplace = replace.replace(/[&/\\]/g, '\\$&');
      
      const pattern = all ? 
        `s/${escapedFind}/${escapedReplace}/g` :
        `s/${escapedFind}/${escapedReplace}/`;
      
      const sedCmd = `sed -i.bak '${pattern}' '${file}'`;
      await execAsync(sedCmd);
      
      return {
        content: [{
          type: 'text',
          text: `Replaced "${find}" with "${replace}" in ${file}`
        }]
      };
    }
  • src/index.ts:117-143 (registration)
    Registration of the 'quick_replace' tool in the MCP server tools list, including name, description, and input schema definition.
    {
      name: 'quick_replace',
      description: 'Simple find and replace across a file without regex',
      inputSchema: {
        type: 'object',
        properties: {
          file: {
            type: 'string',
            description: 'File to edit'
          },
          find: {
            type: 'string',
            description: 'Text to find (literal, not regex)'
          },
          replace: {
            type: 'string',
            description: 'Text to replace with'
          },
          all: {
            type: 'boolean',
            default: true,
            description: 'Replace all occurrences (false = first only)'
          }
        },
        required: ['file', 'find', 'replace']
      }
    },
  • Input schema for 'quick_replace' tool defining parameters: file (string), find (string), replace (string), all (boolean, default true). Required: file, find, replace.
    inputSchema: {
      type: 'object',
      properties: {
        file: {
          type: 'string',
          description: 'File to edit'
        },
        find: {
          type: 'string',
          description: 'Text to find (literal, not regex)'
        },
        replace: {
          type: 'string',
          description: 'Text to replace with'
        },
        all: {
          type: 'boolean',
          default: true,
          description: 'Replace all occurrences (false = first only)'
        }
      },
      required: ['file', 'find', 'replace']
    }
  • Help documentation string for the quick_replace tool, including description and usage examples.
      quick_replace: `quick_replace - Simple find and replace
    =====================================
    Literal text replacement without regex.
    
    Examples:
      // Replace all occurrences
      quick_replace({ file: "doc.txt", find: "Version 1.0", replace: "Version 2.0" })
      
      // Replace only first occurrence  
      quick_replace({ file: "config.ini", find: "debug=true", replace: "debug=false", all: false })
      
      // Replace with special characters
      quick_replace({ file: "data.csv", find: "$price", replace: "\\$19.99" })
    
    Note: Special regex characters are automatically escaped.
    `,
Behavior3/5

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

No annotations are provided, so the description carries the full burden. It discloses the tool's literal text matching behavior ('literal, not regex'), which is a key behavioral trait. However, it doesn't mention other important aspects like whether the operation is destructive (likely yes, but not stated), error handling, or file permissions needed.

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 that front-loads the core functionality ('Simple find and replace across a file') and adds a crucial constraint ('without regex'). Every word earns its place with zero waste.

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

Completeness3/5

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

Given the tool's moderate complexity (file editing operation), no annotations, and no output schema, the description is minimally adequate. It covers the core purpose and key constraint but lacks details on behavioral aspects like destructiveness, error cases, or output format, leaving gaps for an AI agent.

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 the schema already documents all parameters thoroughly. The description adds no additional parameter semantics beyond what's in the schema (e.g., it doesn't explain parameter interactions or provide examples). Baseline 3 is appropriate when the schema does the heavy lifting.

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 tool's purpose with specific verb ('find and replace') and resource ('across a file'), and distinguishes it from siblings by specifying 'without regex' (unlike sed_edit or perl_edit which likely use regex). It's not a tautology of the name 'quick_replace'.

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?

The description provides clear context about when to use this tool ('without regex'), which helps differentiate it from regex-based siblings like sed_edit and perl_edit. However, it doesn't explicitly state when not to use it or name specific alternatives, keeping it at a 4.

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/MikeyBeez/mcp-smalledit'

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