License

Skip to content

You signed in with another tab or window. Reload
to refresh your session. You signed out in another tab or window. Reload
to refresh your session. You switched accounts on another tab or window. Reload
to refresh your session. Dismiss alert

bhouston / mcp-server-text-editor Public

• Notifications
  You must be signed in to change notification settings

• Fork 1

• Star 7

An open source implementation of the Claude built-in text editor tool

www.npmjs.com/package/mcp-server-text-editor

License

MIT license

7 stars
1 fork
Branches
Tags
Activity

Star

Notifications
You must be signed in to change notification settings

bhouston/mcp-server-text-editor

main

Branches
Tags

Go to file

Code

Folders and files

| Name | | Name | Last commit message | Last commit date |
| --- | --- | --- | --- |
| Latest commit
-------------

History
-------

22 Commits

| | |
| .github/workflows | | .github/workflows | | |
| .vscode | | .vscode | | |
| bin | | bin | | |
| src | | src | | |
| test | | test | | |
| .gitignore | | .gitignore | | |
| .npmignore | | .npmignore | | |
| .nvmrc | | .nvmrc | | |
| .prettierignore | | .prettierignore | | |
| .prettierrc | | .prettierrc | | |
| LICENSE | | LICENSE | | |
| README.md | | README.md | | |
| eslint.config.js | | eslint.config.js | | |
| package.json | | package.json | | |
| pnpm-lock.yaml | | pnpm-lock.yaml | | |
| tsconfig.json | | tsconfig.json | | |
| vitest.config.ts | | vitest.config.ts | | |
| View all files | | |

Repository files navigation

Claude Text Editor MCP Server

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

Features

• Identical API to Claude's Text Editor: Implements the exact same interface as Claude's built-in text editor tool
• MCP Server Implementation: Follows the Model Context Protocol standard for AI tool integration
• File Operations:
  • View file contents with optional line range specification
  • Create new files
  • Replace text in existing files
  • Insert text at specific line numbers
  • Undo previous edits

Supported Claude Text Editor Versions

This package implements an equivalent tool to the built-in Claude text editor tool
versions:

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

But using the tool name 'text_editor' to avoid name conflicts with built-in Claude tools.

Installation

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

# Or with pnpm
pnpm add mcp-server-text-editor

Usage

Starting the Server

# Using npx
npx -y mcp-server-text-editor

# Or if installed globally
mcp-server-text-editor

Configuring in Claude Desktop

{
  "mcpServers": {
    "textEditor": {
      "command": "npx",
      "args": ["-y", "mcp-server-text-editor"]
    }
  }
}

Tool Commands

View

View the contents of a file or directory.

{
  "command": "view",
  "path": "/path/to/file.js",
  "view_range": [1, 10] // Optional: Show lines 1-10 only
}

Create

Create a new file with the specified content.

{
  "command": "create",
  "path": "/path/to/file.js",
  "file_text": "console.log('Hello, world!');"
}

String Replace

Replace text in a file.

{
  "command": "str_replace",
  "path": "/path/to/file.js",
  "old_str": "console.log('Hello, world!');",
  "new_str": "console.log('Hello, Claude!');"
}

Insert

Insert text at a specific line.

{
  "command": "insert",
  "path": "/path/to/file.js",
  "insert_line": 5,
  "new_str": "// This line was inserted by Claude"
}

Undo Edit

Revert the last edit made to a file.

{
  "command": "undo_edit",
  "path": "/path/to/file.js"
}

Development

Prerequisites

• Node.js 18+
• pnpm

Setup

# Clone the repository
git clone https://github.com/bhouston/mcp-server-text-editor.git
cd mcp-server-text-editor

# Install dependencies
pnpm install

# Build the project
pnpm build

Scripts

• pnpm build: Build the TypeScript project
• pnpm lint: Run ESLint with auto-fixing
• pnpm format: Format code with Prettier
• pnpm clean: Remove build artifacts
• pnpm clean:all: Remove build artifacts and node_modules
• pnpm test: Run tests
• pnpm test:coverage: Run tests with coverage report

Testing

This project uses Vitest for testing.

To run the tests:

# Run all tests
pnpm test

# Run tests with coverage report
pnpm test:coverage

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

License

MIT

Contributing

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

1. Fork the repository
2. Create your 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

About

An open source implementation of the Claude built-in text editor tool

www.npmjs.com/package/mcp-server-text-editor

Topics

mcp
text-editor
claude
ai-tools
model-context-protocol

Resources

Readme

License

MIT license

Activity

Stars

7 stars

Watchers

1 watching

Forks

1 fork

Report repository

Languages

• TypeScript 94.3%

• JavaScript 5.7%

You can’t perform that action at this time.