Skip to content

Commit 87e409c

Browse files
committed
docs(README.md): update README to clarify line-oriented text editing capabilities and optimize for LLM tools
- Enhance description of the MCP server to specify line-oriented editing. - Add quick start instructions for Claude.app users with configuration details. - Highlight key settings for optimizing token usage in LLM applications. - Emphasize benefits of line-based operations and efficient partial file access.
1 parent f88079c commit 87e409c

File tree

1 file changed

+36
-8
lines changed

1 file changed

+36
-8
lines changed

README.md

Lines changed: 36 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,40 +2,68 @@
22

33
[![codecov](https://codecov.io/gh/tumf/mcp-text-editor/graph/badge.svg?token=52D51U0ZUR)](https://codecov.io/gh/tumf/mcp-text-editor)
44

5-
A Model Context Protocol (MCP) server that provides text file editing capabilities through a standardized API.
5+
A Model Context Protocol (MCP) server that provides line-oriented text file editing capabilities through a standardized API. Optimized for LLM tools with efficient partial file access to minimize token usage.
6+
7+
## Quick Start for Claude.app Users
8+
9+
To use this editor with Claude.app, add the following configuration to your prompt:
10+
11+
```shell
12+
code ~/Library/Application\ Support/Claude/claude_desktop_config.json
13+
```
14+
15+
```json
16+
{
17+
"mcpServers": {
18+
19+
"text-editor": {
20+
"command": "uvx",
21+
"args": [
22+
"mcp-text-editor"
23+
]
24+
},
25+
}
26+
}
27+
```
28+
29+
Key settings for Claude.app:
30+
- Set appropriate `file_extensions` to limit file access
31+
- Adjust `max_file_size` based on your needs
32+
- Configure `max_lines_per_request` to control token usage
33+
- Use line ranges to minimize token consumption when reading large files
634

735
## Overview
836

9-
MCP Text Editor Server is designed to facilitate safe and efficient text file operations in a client-server architecture. It implements the Model Context Protocol, ensuring reliable file editing with robust conflict detection and resolution. This makes it ideal for applications requiring synchronized file access, such as collaborative editing tools, automated text processing systems, or any scenario where multiple processes need to modify text files safely.
37+
MCP Text Editor Server is designed to facilitate safe and efficient line-based text file operations in a client-server architecture. It implements the Model Context Protocol, ensuring reliable file editing with robust conflict detection and resolution. The line-oriented approach makes it ideal for applications requiring synchronized file access, such as collaborative editing tools, automated text processing systems, or any scenario where multiple processes need to modify text files safely. The partial file access capability is particularly valuable for LLM-based tools, as it helps reduce token consumption by loading only the necessary portions of files.
1038

1139
### Key Benefits
1240

41+
- Line-based editing operations
42+
- Token-efficient partial file access with line-range specifications
43+
- Optimized for LLM tool integration
1344
- Safe concurrent editing with hash-based validation
14-
- Efficient partial file access with line-range specifications
1545
- Atomic multi-file operations
1646
- Robust error handling and recovery mechanisms
1747

18-
1948
## Features
2049

50+
- Line-oriented text file editing and reading
51+
- Smart partial file access to minimize token usage in LLM applications
2152
- Get text file contents with line range specification
2253
- Read multiple ranges from multiple files in a single operation
54+
- Line-based patch application with correct handling of line number shifts
2355
- Edit text file contents with conflict detection
2456
- Support for multiple file operations
2557
- Proper handling of concurrent edits with hash-based validation
26-
- Line-based patch application with correct handling of line number shifts
27-
- Robust error handling and validation
2858
- Memory-efficient processing of large files
2959

30-
3160
## Requirements
3261

3362
- Python 3.11 or higher
3463
- POSIX-compliant operating system (Linux, macOS, etc.) or Windows
3564
- Sufficient disk space for text file operations
3665
- File system permissions for read/write operations
3766

38-
3967
1. Install Python 3.11+
4068

4169
```bash

0 commit comments

Comments
 (0)