Files

by flesler

359 downloads
Not rated
GitHub

About

Enables agents to quickly find and edit code in a codebase with surgical precision. Find symbols, edit them everywhere.

Details

Author
flesler
Downloads
359
Categories
Other, AI

- Find code symbols anywhere in the codebase with read_symbol.
- Perform intelligent search-and-replace with search_replace.
- Insert or replace text at exact line ranges with insert_text.
- Inspect JavaScript/TypeScript modules and their properties.
- Send native OS notifications with os_notification.
- Supports both stdio and HTTP transport modes.
- Requires Node.js 20 or higher.

Setting up with Highlight

This MCP is not yet compatible with Highlight’s one-click setup. However, you can still use it with Highlight by following these steps:

  1. Download and install Highlight from highlightai.com/download
  2. Navigate to the plugins tab and select "Add Custom Plugin"
  3. Configure the plugin with the settings below
    Plugin Name Files
    Command (node, npx, python, etc.)

    Please refer to the README for specific instructions on how to obtain API keys or other required environment variables.

  4. Enable "Start Automatically" if you want the plugin to start when Highlight launches

From the repository

Install and run via npx mcp-files or as a Docker container. Configure the MCP client (e.g., Cursor or Claude Desktop) with a JSON entry pointing to npx -y mcp-files. Alternatively use HTTP transport by setting the environment variable TRANSPORT=http. Tools can also be invoked directly from the command line, e.g., mcp-files read_symbol "MySymbol" src/file.ts.

read_symbol

Find and extract symbol block by name from files, supports a lot of file formats (like TS, JS, GraphQL, CSS and most that use braces for blocks). Uses streaming with concurrency control for better performance

insert_text

Insert or replace text at precise line ranges in files - Ideal for direct line-number operations (from code citations like 12:15:file.ts) and large files where context-heavy editing is inefficient. - TIP: Combine with read_symbol (must use optimize: false!) to edit any symbol anywhere without knowing its file or line range!

os_notification

Send OS notifications using native notification systems.

Claude Desktop / Cursor

Paste into your MCP client config file to install this server.

{
    "mcpServers": {
        "files": {
            "mcp-files": {
                "command": "npx",
                "args": [
                    "-y",
                    "mcp-files"
                ]
            }
        }
    }
}

McpServers

{
    "mcp-files": {
        "command": "npx",
        "args": [
            "-y",
            "mcp-files"
        ]
    }
}

MCP Tools

Install MCP Server
npm version
Node.js
License: MIT
Docker

A comprehensive MCP server providing helpful tools for AI agents like Cursor.

πŸ“‹ Table of Contents

- πŸš€ Quick Start
- πŸ› οΈ Available Tools
- ⚑ Surgical Code Editing: Superhuman Precision
- πŸŽ›οΈ Environment Variables
- πŸ–₯️ Server Usage
- πŸ’» CLI Usage
- πŸ—οΈ Architecture
- πŸ§ͺ Development
- πŸ› οΈ Troubleshooting
- πŸ“ License
- πŸ”— Links

πŸš€ Quick Start

Option 1: NPX (Recommended)

Add this to ~/.cursor/mcp.json for Cursor, ~/.config/claude_desktop_config.json for Claude Desktop.

{
  "mcpServers": {
    "mcp-files": {
      "command": "npx",
      "args": ["-y", "mcp-files"]
    }
  }
}

Option 2: Docker

{
  "mcpServers": {
    "mcp-files": {
      "command": "docker",
      "args": [
        "run",
        "--rm",
        "-i",
        "flesler/mcp-files"
      ]
    }
  }
}

Option 3: HTTP transport

{
  "mcpServers": {
    "mcp-files": {
      "command": "npx",
      "args": ["-y", "mcp-files"],
      "env": {
        "TRANSPORT": "http",
        "PORT": "3000"
      }
    }
  }
}

πŸ› οΈ Available Tools

| Tool | Description | Parameters |
|------|-------------|------------|
| read_symbol | Find and extract code blocks by symbol name from files | symbol, file_paths[]?, limit? |
| import_symbol | Import and inspect JavaScript/TypeScript modules and their properties | module_path, property? |
| search_replace | Search and replace with intelligent whitespace handling and automation-friendly multiple match resolution | file_path, old_string, new_string |
| insert_text | Insert/replace text at precise line ranges. Perfect for direct line operations from code citations (12:15:file.ts) and surgical edits in large files | file_path, from_line, text, to_line |
| os_notification | Send OS notifications using native notification systems | message, title? |

⚑ Surgical Code Editing: Superhuman Precision

The combination of read_symbol + insert_text unlocks revolutionary code editing capabilities that transform how AI agents work with codebases.

🎯 The Power Combo

1. Symbol Discovery (read_symbol) - Find ANY symbol ANYWHERE in your codebase:

// Find function/class/interface anywhere in repo
read_symbol("generateApiKey")
// β†’ Returns: exact location (lines 45-52 in src/auth/tokens.ts)

2. Surgical Editing (insert_text) - Make precise modifications using exact line ranges:

// Replace specific lines with surgical precision
insert_text(file: "src/auth/tokens.ts", from_line: 45, to_line: 52, text: "improved implementation")

// Insert new code without disruption
insert_text(file: "src/auth/tokens.ts", from_line: 45, text: "// Added security enhancement")

πŸš€ Superpowers Unlocked

πŸ” Cross-Codebase Intelligence
- Find any symbol across entire repositories instantly
- No manual searching through files and folders
- Perfect accuracy even in massive codebases

βœ‚οΈ Precision Surgery
- Edit exact functions, classes, or code blocks
- Replace implementations without affecting surrounding code
- Insert enhancements at perfect locations

πŸŽ›οΈ Zero-Error Refactoring
- Update function signatures everywhere they exist
- Modify APIs across all files simultaneously
- Fix bugs with surgical precision across entire codebase

πŸ’‘ Real-World Magic

# Find and enhance any function
read_symbol("validateEmail") β†’ lines 23-35 in utils/validation.ts
insert_text(from_line: 23, to_line: 35, text: "enhanced validation with regex")

Add documentation to any symbol

read_symbol("processPayment") β†’ line 87 in payment/processor.ts insert_text(from_line: 87, text: "/ Secure payment processing with fraud detection /")

Fix bugs anywhere in codebase

read_symbol("parseUserInput") β†’ lines 156-162 in input/parser.ts insert_text(from_line: 156, to_line: 162, text: "sanitized parsing logic")

This transforms AI from "helpful assistant" to "superhuman code surgeon" 🦾

πŸŽ›οΈ Environment Variables

| Variable | Default | Description |
|----------|---------|-------------|
| TRANSPORT | stdio | Transport mode: stdio or http |
| PORT | 4657 | HTTP server port (when TRANSPORT=http) |
| DEBUG | false | Enable debug mode and utils_debug tool |

πŸ–₯️ Server Usage

You can either install and use mcp-files or npx mcp-files.

# Show help
mcp-files --help

Default: stdio transport

mcp-files

HTTP transport

TRANSPORT=http mcp-files TRANSPORT=http PORT=8080 mcp-files

With debug mode

DEBUG=true mcp-files

πŸ’» CLI Usage

All tools can be used directly from the command line:

# Find symbol in code (specific file)
mcp-files read_symbol "MyInterface" src/types.ts

Find symbol in current directory (default)

mcp-files read_symbol "MyInterface"

Inspect imports

mcp-files import_symbol lodash get

Replace text with smart whitespace handling

mcp-files replace_text config.json "old_value" "new_value"

Send notifications

mcp-files os_notification "Task completed"

πŸ—οΈ Architecture

- Type-safe tools with Zod validation
-
Self-contained modules in src/tools/
-
Cross-platform support (Linux, macOS, Windows, WSL)
-
Performance optimized with memoization
-
Clear error handling with descriptive messages

πŸ§ͺ Development

# Install dependencies
npm install

Build

npm run build

Development mode

npm run dev

Lint

npm run lint:full

Test

npm run ts test/index.test.ts

CLI testing

node dist/index.js read_symbol "functionName" file.ts

Or search current directory

node dist/index.js read_symbol "functionName"

πŸ› οΈ Troubleshooting

Requirements

- Node.js β‰₯20 - This package requires Node.js version 20 or higher

Common Issues

ERR_MODULE_NOT_FOUND when running npx mcp-files
-
Problem: Error like Cannot find module '@modelcontextprotocol/sdk/dist/esm/server/index.js' when running npx mcp-files
-
Cause: Corrupt or incomplete npx cache preventing proper dependency resolution
-
Solution: Clear the npx cache and try again:

  npx clear-npx-cache
npx mcp-files

-
Note: This issue can occur on both Node.js v20 and v22, and the cache clear resolves it

Tools not showing up in MCP client:
- Verify Node.js version is 20 or higher
- Try restarting your MCP client after configuration changes

File operations failing:
- Ensure proper file permissions for the files you're trying to read/modify
- Use absolute paths when possible for better reliability
- Check that the target files exist and are accessible

πŸ“ License

MIT - see LICENSE file.

πŸ”— Links

- πŸ“¦ NPM Package
- πŸ™
GitHub Repository
- πŸ›
Report Issues
- πŸ“š
MCP Specification

---

Built for AI agents* πŸ€–

No reviews yet β€” be the first

Sign in to leave a review

Use Google, GitHub, or an email account so ratings stay tied to real people.

Email sign in

No reviews posted yet.