MCP Server Text Editor

🚀 Claude Text Editor MCP Server

An open - source implementation of the Model Context Protocol (MCP) server that mimics Claude's built - in text editor tool. This package provides the same interface as Claude's built - in text editor tool, allowing users to view, edit, and create text files through a standard API.

✨ Features

• Same API as Claude Text Editor: Implements the exact same interface as Claude's built - in text editor tool.
• MCP Server Implementation: Follows the standard Model Context Protocol for AI tool integration.
• File Operations:
  • View file content, optionally specifying a line range.
  • Create new files.
  • Replace text in an existing file.
  • Insert text at a specific line.
  • Undo the last edit.

📦 Supported Claude Text Editor Versions

This package implements the same functionality as Claude's built - in text editor tool and supports the following versions:

• text_editor_20241022 (Claude 3.5 Sonnet)
• text_editor_20250124 (Claude 3.7 Sonnet)

It uses the tool name 'textEditor' to avoid naming conflicts with Claude's built - in tools.

📦 Installation

# Install from npm
npm install mcp-server-text-editor

💻 Usage Examples

Basic Usage

Initial Configuration

Import and initialize the text editor server in your project:

import { TextEditorServer } from 'mcp-server-text-editor';

// Create a text editor server instance
const textEditor = new TextEditorServer({
  port: 3000, // Optional, default port is 3000
  logger: console // Optional, default uses console logging
});

Usage Examples

// View help information
textEditor.help();

// Display version information
textEditor.version();

// Open a file for editing
textEditor.open('path/to/file.txt', (content) => {
  // Edit the content here
});

// Create a new file
textEditor.create('newFile.txt', () => {
  console.log('File has been created');
});

Advanced Usage

Configuration Example

Here is a complete configuration example:

const config = {
  port: 3001,
  logger: {
    log: console.log,
    error: console.error
  },
  middleware: [
    // Custom middleware
    (req, res, next) => {
      console.log('Request from:', req.ip);
      next();
    }
  ]
};

const textEditor = new TextEditorServer(config);

🔧 Development

Install Dependencies

npm install

Start the Test Server

npm run dev

Testing

This project uses Vitest for testing.

Run All Tests

npm test

Tests with Coverage Report

npm test:coverage

The test coverage report will be generated in the coverage directory.

📄 License

MIT

👥 Contribution

Contributions are welcome! Please feel free to submit a Pull Request.

1. Fork the repository.
2. Create a feature branch (git checkout -b feature/amazing - feature).
3. Commit your changes (git commit -m 'Add some amazing feature').
4. Push to the branch (git push origin feature/amazing - feature).
5. Open a Pull Request.