Skip to content

MCP Server Configuration

Learn how to configure the Renamify MCP Server for different AI assistants and customize its behavior.

The minimal configuration for any MCP client:

{
"mcpServers": {
"renamify": {
"command": "npx",
"args": ["-y", "@renamify/mcp-server"]
}
}
}

If renamify is not in your PATH, you can specify a custom location:

{
"mcpServers": {
"renamify": {
"command": "npx",
"args": ["-y", "@renamify/mcp-server"],
"env": {
"RENAMIFY_PATH": "/custom/path/to/renamify"
}
}
}
}

Specify a default working directory for renaming operations:

{
"mcpServers": {
"renamify": {
"command": "npx",
"args": ["-y", "@renamify/mcp-server"],
"cwd": "/path/to/your/project"
}
}
}

Enable debug logging for troubleshooting:

{
"mcpServers": {
"renamify": {
"command": "npx",
"args": ["-y", "@renamify/mcp-server"],
"env": {
"DEBUG": "renamify:*",
"LOG_LEVEL": "debug"
}
}
}
}

Location: Platform-specific configuration file

  • macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
  • Windows: %APPDATA%\Claude\claude_desktop_config.json
  • Linux: ~/.config/Claude/claude_desktop_config.json

Full configuration example:

{
"mcpServers": {
"renamify": {
"command": "npx",
"args": ["-y", "@renamify/mcp-server"],
"env": {
"RENAMIFY_PATH": "/usr/local/bin/renamify"
}
}
}
}

The MCP Server respects these environment variables:

  • Type: String
  • Default: renamify (searches PATH)
  • Description: Path to the renamify binary
  • Type: String
  • Default: (none)
  • Description: Enable debug output with renamify:*
  • Type: String
  • Default: info
  • Description: Logging level: error, warn, info, debug
  • Type: Boolean
  • Default: false
  • Description: Disable colored output

You can configure default behaviors for the MCP tools:

The MCP Server defaults to summary format for AI agents. To change:

{
"env": {
"RENAMIFY_DEFAULT_PREVIEW": "table" // or "diff", "json"
}
}

To always create git commits after applying changes:

{
"env": {
"RENAMIFY_AUTO_COMMIT": "true"
}
}

For extra safety, make all operations dry-run by default:

{
"env": {
"RENAMIFY_DEFAULT_DRY_RUN": "true"
}
}

You can create a .renamify/config.json file in your project root:

{
"defaults": {
"styles": ["snake", "camel", "pascal", "kebab"],
"excludes": [
"node_modules/**",
"dist/**",
"build/**",
".git/**"
],
"renameFiles": true,
"renameDirs": true,
"atomic": true
},
"mcp": {
"preview": "summary",
"autoCommit": false,
"commitMessage": "renamify: {old} → {new}"
}
}

Configure different settings for different projects:

{
"mcpServers": {
"renamify-project1": {
"command": "npx",
"args": ["-y", "@renamify/mcp-server"],
"cwd": "/path/to/project1",
"env": {
"RENAMIFY_AUTO_COMMIT": "true"
}
},
"renamify-project2": {
"command": "npx",
"args": ["-y", "@renamify/mcp-server"],
"cwd": "/path/to/project2",
"env": {
"RENAMIFY_DEFAULT_DRY_RUN": "true"
}
}
}
}

For large codebases, increase Node.js memory limit:

{
"env": {
"NODE_OPTIONS": "--max-old-space-size=4096"
}
}

Enable parallel file processing:

{
"env": {
"RENAMIFY_PARALLEL": "true",
"RENAMIFY_WORKERS": "4"
}
}

Limit renaming to specific directories:

{
"env": {
"RENAMIFY_ALLOWED_PATHS": "/home/user/projects,/home/user/work",
"RENAMIFY_RESTRICT_MODE": "true"
}
}

Enable read-only mode for planning without applying:

{
"env": {
"RENAMIFY_READ_ONLY": "true"
}
}

Test your configuration with a simple request to your AI assistant:

“Can you list the available Renamify tools?”

The assistant should respond with the 7 available tools.

Enable comprehensive debugging:

{
"env": {
"DEBUG": "*",
"LOG_LEVEL": "debug",
"RENAMIFY_VERBOSE": "true"
}
}

Tools not appearing:

  • Check JSON syntax is valid
  • Ensure paths use forward slashes (even on Windows)
  • Restart your AI assistant after changes

Permission errors:

  • Ensure the renamify binary is executable
  • Check file system permissions for your project

Binary not found:

  • Use absolute paths in RENAMIFY_PATH
  • Verify the binary exists at the specified location
{
"mcpServers": {
"renamify-dev": {
"command": "npx",
"args": ["-y", "@renamify/mcp-server"],
"env": {
"LOG_LEVEL": "debug",
"RENAMIFY_DEFAULT_DRY_RUN": "true",
"RENAMIFY_AUTO_COMMIT": "false"
}
}
}
}
{
"mcpServers": {
"renamify-prod": {
"command": "renamify-mcp",
"env": {
"LOG_LEVEL": "error",
"RENAMIFY_AUTO_COMMIT": "true",
"RENAMIFY_RESTRICT_MODE": "true",
"RENAMIFY_ALLOWED_PATHS": "/var/www/app"
}
}
}
}
{
"mcpServers": {
"renamify-ci": {
"command": "npx",
"args": ["-y", "@renamify/mcp-server"],
"env": {
"RENAMIFY_READ_ONLY": "true",
"RENAMIFY_DEFAULT_PREVIEW": "json",
"CI": "true"
}
}
}
}

Tools Reference

Detailed documentation for each MCP tool

Usage Examples

Real-world renaming scenarios

AI Agent Guide

Best practices for AI-assisted renaming