Refactor MCP

🚀 refactor-mcp

A Model Context Protocol (MCP) server that offers powerful refactoring tools for Coding Agents. It supports two operating modes:

• MCP Server Mode (default): Integrates seamlessly with MCP-compatible clients such as Claude Code.
• CLI Mode: Enables direct command-line usage for standalone refactoring tasks.

✨ Features

This MCP server comes equipped with two primary tools to facilitate code refactoring:

🔧 code_refactor

Conducts regex-based search and replace operations across files, featuring advanced filtering capabilities.

Parameters:

• search_pattern (string) - The regular expression pattern to search for.
• replace_pattern (string) - The replacement pattern (supports capture groups like $1, $2).
• context_pattern (string, optional) - Only replace matches within this specified context.
• file_pattern (string, optional) - A glob pattern to restrict the scope to specific files (e.g., *.js, src/**/*.ts).

Example:

// Replace foo() calls with bar() calls
code_refactor("foo\\((.+)\\)", "bar($1)")

// Before: let k = foo(1,2,3);
// After:  let k = bar(1,2,3);

Context-aware refactoring:

// Only replace "legacy_sdk" within import statements
code_refactor("legacy_sdk", "brand_new_sdk", "import")

🔍 code_search

Searches for regex patterns and returns the file locations along with precise line numbers.

Parameters:

• search_pattern (string) - The regular expression pattern to search for.
• context_pattern (string, optional) - Filters matches based on the surrounding context.
• file_pattern (string, optional) - A glob pattern to limit the search scope.

Example:

code_search("foo\\(.+\\)")

// Result:
// ./src/utils.js (line: 15)
// ./src/helpers.ts (lines: 23-27)

📦 Installation

Quick Start

MCP Server Mode (for Claude Code and other MCP clients):

# Install globally for MCP integration
npm install -g @myuon/refactor-mcp

# Or use with npx (recommended for MCP clients)
npx @myuon/refactor-mcp@latest

CLI Mode (for direct command-line usage):

# Search for patterns
npx @myuon/refactor-mcp@latest cli search -p "function.*\(" -f "src/**/*.js"

# Refactor with preview
npx @myuon/refactor-mcp@latest cli refactor -s "const (\w+)" -r "let \$1" --dry-run

For Development

# Clone and install dependencies
git clone https://github.com/myuon/refactor-mcp.git
cd refactor-mcp
npm install

💻 Usage Examples

CLI Mode

You can directly utilize the refactoring tools from the command line by appending cli after the main command:

# Search for patterns
refactor-mcp cli search -p "function (.*) \{" -f "src/**/*.ts"

# Search with matched content display
refactor-mcp cli search -p "function (.*) \{" -f "src/**/*.ts" --print

# Refactor with dry-run (preview changes)
refactor-mcp cli refactor -s "const (\w+) = " -r "let \$1 = " --dry-run

# Refactor with matched content display
refactor-mcp cli refactor -s "const (\w+) = " -r "let \$1 = " --print --dry-run

# Refactor with file pattern
refactor-mcp cli refactor -s "old_function" -r "new_function" -f "src/**/*.js"

# Context-aware refactoring
refactor-mcp cli refactor -s "legacy_sdk" -r "new_sdk" -c "import" -f "src/**/*.ts"

CLI Commands:

• search - Search for code patterns
  • -p, --pattern <pattern> - The regular expression pattern to search for.
  • -c, --context <context> - An optional context pattern to filter matches.
  • -f, --files <files> - An optional file glob pattern to limit the search scope.
  • --print - Print the matched content to stdout.
  • --matched - Display only the matched text with capture groups.
• refactor - Refactor code using regex replacement
  • -s, --search <search> - The regular expression pattern to search for.
  • -r, --replace <replace> - The replacement pattern (supports $1, $2, etc.).
  • -c, --context <context> - An optional context pattern to filter matches.
  • -f, --files <files> - An optional file glob pattern to limit the search scope.
  • --dry-run - Preview changes without modifying files.
  • --print - Print the matched content and replacements to stdout.

⚠️ Important Note

When using capture groups in replacement patterns on the command line, escape the dollar sign: \$1, \$2, etc. Example: refactor-mcp cli refactor -s "const (\w+) = " -r "let \$1 = " --dry-run This prevents the shell from interpreting $1 as a shell variable

MCP Server Mode (Default)

By default, refactor-mcp operates as an MCP server via stdio transport:

# Run as MCP server (default mode)
refactor-mcp

# Or explicitly with npx
npx @myuon/refactor-mcp@latest

Development

npm run dev          # Run server in development mode
npm run dev:cli      # Run CLI in development mode with arguments
npm run cli          # Run CLI directly (for testing)
npm run build        # Build for production
npm start            # Run built server (MCP mode)

Code Quality

npm run check        # Run all quality checks
npm run lint         # Run ESLint
npm run format       # Format code with Prettier
npm test             # Run tests

📚 Documentation

MCP Integration

This server employs the Model Context Protocol to communicate with compatible clients. It operates via stdio transport and can be integrated into any MCP-compatible environment.

Claude Code Integration

For Claude Code users, you can effortlessly add this MCP server with:

claude mcp add refactor npx @myuon/refactor-mcp@latest

Manual Configuration

Add the following to your MCP client configuration:

{
  "mcpServers": {
    "refactor-mcp": {
      "command": "npx",
      "args": ["@myuon/refactor-mcp@latest"]
    }
  }
}

Alternative Configuration (Local Installation)

{
  "mcpServers": {
    "refactor-mcp": {
      "command": "refactor-mcp"
    }
  }
}

🔧 Technical Details

• Framework: Model Context Protocol SDK for TypeScript
• Runtime: Node.js with ES modules
• Validation: Zod schemas for type-safe input validation
• File Operations: Native fs module with glob pattern matching
• Testing: Vitest with comprehensive test coverage

🤝 Contributing

1. Install dependencies: npm install
2. Run tests: npm test
3. Check code quality: npm run check
4. Build: npm run build

📄 License

MIT