mcp-text-editor

by tumf
MIT License
79
  • Apple
  • Linux

local-only server

The server can only run on the client’s local machine because it depends on local resources.

Integrations

  • Integration for code coverage reporting, as indicated by the codecov badge in the README.

Servidor editor de texto MCP

Un servidor de Protocolo de Contexto de Modelo (MCP) que ofrece funciones de edición de archivos de texto orientados a líneas mediante una API estandarizada. Optimizado para herramientas LLM con acceso parcial eficiente a archivos para minimizar el uso de tokens.

Inicio rápido para usuarios de Claude.app

Para utilizar este editor con Claude.app, agregue la siguiente configuración a su mensaje:

code ~/Library/Application\ Support/Claude/claude_desktop_config.json
{ "mcpServers": { "text-editor": { "command": "uvx", "args": [ "mcp-text-editor" ] } } }

o con docker:

{ "mcpServers": { "text-editor": { "command": "docker", "args": [ "run", "-i", "--rm", "--mount", "type=bind,src=/some/path/src,dst=/some/path/dst", "mcp/text-editor" ] } } }

Descripción general

El Servidor del Editor de Texto MCP está diseñado para facilitar operaciones seguras y eficientes con archivos de texto basados en líneas en una arquitectura cliente-servidor. Implementa el Protocolo de Contexto de Modelo, lo que garantiza una edición de archivos fiable con una robusta detección y resolución de conflictos. Su enfoque orientado a líneas lo hace ideal para aplicaciones que requieren acceso sincronizado a archivos, como herramientas de edición colaborativa, sistemas de procesamiento de texto automatizado o cualquier escenario donde varios procesos necesiten modificar archivos de texto de forma segura. La capacidad de acceso parcial a archivos es especialmente valiosa para herramientas basadas en LLM, ya que ayuda a reducir el consumo de tokens al cargar solo las partes necesarias de los archivos.

Beneficios clave

  • Operaciones de edición basadas en líneas
  • Acceso parcial a archivos con uso eficiente de tokens y especificaciones de rango de línea
  • Optimizado para la integración de herramientas LLM
  • Edición concurrente segura con validación basada en hash
  • Operaciones atómicas de múltiples archivos
  • Manejo robusto de errores con tipos de errores personalizados
  • Soporte de codificación completo (utf-8, shift_jis, latin1, etc.)

Características

  • Edición y lectura de archivos de texto orientados a líneas
  • Acceso parcial inteligente a archivos para minimizar el uso de tokens en aplicaciones LLM
  • Obtener el contenido del archivo de texto con la especificación del rango de líneas
  • Leer múltiples rangos de múltiples archivos en una sola operación
  • Aplicación de parches basada en líneas con manejo correcto de cambios de número de línea
  • Editar el contenido de archivos de texto con detección de conflictos
  • Soporte de codificación de caracteres flexible (utf-8, shift_jis, latin1, etc.)
  • Soporte para múltiples operaciones con archivos
  • Manejo adecuado de ediciones concurrentes con validación basada en hash
  • Procesamiento de archivos grandes con uso eficiente de la memoria

Requisitos

  • Python 3.11 o superior
  • Sistema operativo compatible con POSIX (Linux, macOS, etc.) o Windows
  • Suficiente espacio en disco para operaciones con archivos de texto
  • Permisos del sistema de archivos para operaciones de lectura y escritura
  1. Instalar Python 3.11+
pyenv install 3.11.6 pyenv local 3.11.6
  1. Instalar uv (recomendado) o pip
curl -LsSf https://astral.sh/uv/install.sh | sh
  1. Crear entorno virtual e instalar dependencias
uv venv source .venv/bin/activate # On Windows: .venv\Scripts\activate uv pip install -e ".[dev]"

Requisitos

  • Python 3.13+
  • Sistema operativo compatible con POSIX (Linux, macOS, etc.) o Windows
  • Permisos del sistema de archivos para operaciones de lectura y escritura

Instalación

Ejecutar a través de uvx

uvx mcp-text-editor

Instalación mediante herrería

Para instalar Text Editor Server para Claude Desktop automáticamente a través de Smithery :

npx -y @smithery/cli install mcp-text-editor --client claude

Instalación manual

  1. Instalar Python 3.13+
pyenv install 3.13.0 pyenv local 3.13.0

Instalación de Docker

docker build --network=host -t mcp/text-editor .
  1. Instalar uv (recomendado) o pip
curl -LsSf https://astral.sh/uv/install.sh | sh
  1. Crear entorno virtual e instalar dependencias
uv venv source .venv/bin/activate # On Windows: .venv\Scripts\activate uv pip install -e ".[dev]"

Uso

Iniciar el servidor:

python -m mcp_text_editor

Inicie el servidor con Docker:

docker run -i --rm --mount "type=bind,src=/some/path/src,dst=/some/path/dst" mcp/text-editor

con el inspector:

npx @modelcontextprotocol/inspector docker run -i --rm --mount "type=bind,src=/some/path/src,dst=/some/path/dst" mcp/text-editor

Herramientas MCP

El servidor proporciona varias herramientas para la manipulación de archivos de texto:

obtener_el_contenido_del_archivo_de_texto

Obtenga el contenido de uno o más archivos de texto con especificación de rango de línea.

Solicitud de rango único:

{ "file_path": "path/to/file.txt", "line_start": 1, "line_end": 10, "encoding": "utf-8" // Optional, defaults to utf-8 }

Solicitud de rangos múltiples:

{ "files": [ { "file_path": "file1.txt", "ranges": [ {"start": 1, "end": 10}, {"start": 20, "end": 30} ], "encoding": "shift_jis" // Optional, defaults to utf-8 }, { "file_path": "file2.txt", "ranges": [ {"start": 5, "end": 15} ] } ] }

Parámetros:

  • file_path : Ruta al archivo de texto
  • line_start / start : Número de línea desde el que comenzar (basado en 1)
  • line_end / end : Número de línea donde finalizar (inclusive, nulo para el final del archivo)
  • encoding : Codificación del archivo (predeterminado: "utf-8"). Especifique la codificación del archivo de texto (p. ej., "shift_jis", "latin1").

Respuesta de rango único:

{ "contents": "File contents", "line_start": 1, "line_end": 10, "hash": "sha256-hash-of-contents", "file_lines": 50, "file_size": 1024 }

Respuesta de rangos múltiples:

{ "file1.txt": [ { "content": "Lines 1-10 content", "start": 1, "end": 10, "hash": "sha256-hash-1", "total_lines": 50, "content_size": 512 }, { "content": "Lines 20-30 content", "start": 20, "end": 30, "hash": "sha256-hash-2", "total_lines": 50, "content_size": 512 } ], "file2.txt": [ { "content": "Lines 5-15 content", "start": 5, "end": 15, "hash": "sha256-hash-3", "total_lines": 30, "content_size": 256 } ] }

contenido del archivo de texto del parche

Aplique parches a archivos de texto con gestión robusta de errores y detección de conflictos. Admite la edición de varios archivos en una sola operación.

Formato de solicitud:

{ "files": [ { "file_path": "file1.txt", "hash": "sha256-hash-from-get-contents", "encoding": "utf-8", // Optional, defaults to utf-8 "patches": [ { "start": 5, "end": 8, "range_hash": "sha256-hash-of-content-being-replaced", "contents": "New content for lines 5-8\n" }, { "start": 15, "end": null, // null means end of file "range_hash": "sha256-hash-of-content-being-replaced", "contents": "Content to append\n" } ] } ] }

Notas importantes:

  1. Obtenga siempre el hash actual y range_hash usando get_text_file_contents antes de editar
  2. Los parches se aplican de abajo a arriba para manejar correctamente los cambios de número de línea
  3. Los parches no deben superponerse dentro del mismo archivo
  4. Los números de línea se basan en 1
  5. end: null para agregar contenido al final del archivo
  6. La codificación del archivo debe coincidir con la codificación utilizada en get_text_file_contents

Respuesta de éxito:

{ "file1.txt": { "result": "ok", "hash": "sha256-hash-of-new-contents" } }

Respuesta de error con sugerencias:

{ "file1.txt": { "result": "error", "reason": "Content hash mismatch", "suggestion": "get", // Suggests using get_text_file_contents "hint": "Please run get_text_file_contents first to get current content and hashes" } }
"result": "error", "reason": "Content hash mismatch - file was modified", "hash": "current-hash", "content": "Current file content"

} }

### Common Usage Pattern 1. Get current content and hash: ```python contents = await get_text_file_contents({ "files": [ { "file_path": "file.txt", "ranges": [{"start": 1, "end": null}] # Read entire file } ] })
  1. Editar el contenido del archivo:
result = await edit_text_file_contents({ "files": [ { "path": "file.txt", "hash": contents["file.txt"][0]["hash"], "encoding": "utf-8", # Optional, defaults to "utf-8" "patches": [ { "line_start": 5, "line_end": 8, "contents": "New content\n" } ] } ] })
  1. Manejar conflictos:
if result["file.txt"]["result"] == "error": if "hash mismatch" in result["file.txt"]["reason"]: # File was modified by another process # Get new content and retry pass

Manejo de errores

El servidor maneja varios casos de error:

  • Archivo no encontrado
  • Errores de permisos
  • Desajustes de hash (detección de edición concurrente)
  • Rangos de parches no válidos
  • Parches superpuestos
  • Errores de codificación (cuando el archivo no se puede decodificar con la codificación especificada)
  • Número de línea fuera de límites

Consideraciones de seguridad

  • Validación de ruta de archivo: el servidor valida todas las rutas de archivo para evitar ataques de recorrido de directorio
  • Control de acceso: se deben configurar los permisos adecuados del sistema de archivos para restringir el acceso a los directorios autorizados
  • Validación de hash: todas las modificaciones de archivos se validan utilizando hashes SHA-256 para evitar condiciones de carrera
  • Sanitización de entrada: todas las entradas del usuario se desinfectan y validan adecuadamente
  • Manejo de errores: La información confidencial no se expone en los mensajes de error

Solución de problemas

Problemas comunes

  1. Permiso denegado
    • Comprobar permisos de archivos y directorios
    • Asegúrese de que el proceso del servidor tenga el acceso de lectura y escritura necesario
  2. Errores de hash de rango y desajuste de hash
    • El archivo fue modificado por otro proceso
    • El contenido que se está reemplazando ha cambiado
    • Ejecute get_text_file_contents para obtener hashes nuevos
  3. Problemas de codificación
    • Verificar que la codificación del archivo coincida con la codificación especificada
    • Utilice utf-8 para archivos nuevos
    • Comprobar marcadores de lista de materiales en los archivos
  4. Problemas de conexión
    • Verifique que el servidor esté en ejecución y sea accesible
    • Compruebe la configuración de la red y la configuración del firewall
  5. Problemas de rendimiento
    • Considere usar rangos de líneas más pequeños para archivos grandes
    • Monitorear los recursos del sistema (memoria, espacio en disco)
    • Utilice la codificación adecuada para el tipo de archivo

Desarrollo

Configuración

  1. Clonar el repositorio
  2. Crear y activar un entorno virtual de Python
  3. Instalar dependencias de desarrollo: uv pip install -e ".[dev]"
  4. Ejecutar pruebas: make all

Herramientas de calidad del código

  • Ruff para pelusa
  • Negro para formato de código
  • isort para la clasificación de importaciones
  • mypy para verificación de tipos
  • pytest-cov para la cobertura de pruebas

Pruebas

Las pruebas se encuentran en el directorio tests y se pueden ejecutar con pytest:

# Run all tests pytest # Run tests with coverage report pytest --cov=mcp_text_editor --cov-report=term-missing # Run specific test file pytest tests/test_text_editor.py -v

Cobertura de prueba actual: 90%

Estructura del proyecto

mcp-text-editor/ ├── mcp_text_editor/ │ ├── __init__.py │ ├── __main__.py # Entry point │ ├── models.py # Data models │ ├── server.py # MCP Server implementation │ ├── service.py # Core service logic │ └── text_editor.py # Text editor functionality ├── tests/ # Test files └── pyproject.toml # Project configuration

Licencia

Instituto Tecnológico de Massachusetts (MIT)

Contribuyendo

  1. Bifurcar el repositorio
  2. Crear una rama de características
  3. Realiza tus cambios
  4. Ejecutar pruebas y controles de calidad del código
  5. Enviar una solicitud de extracción

Sugerencias de tipo

Este proyecto utiliza sugerencias de tipo de Python en todo el código. Por favor, asegúrese de que todas las contribuciones las mantengan.

Manejo de errores

Todos los casos de error deben gestionarse adecuadamente y devolver mensajes de error significativos. El servidor nunca debe bloquearse debido a operaciones de entrada o archivo no válidas.

Pruebas

Las nuevas funciones deben incluir pruebas adecuadas. Intente mantener o mejorar la cobertura de pruebas actual.

Estilo de código

Todo el código debe estar formateado con Black y pasar el control de linting de Ruff. La ordenación de las importaciones debe ser gestionada por isort.

ID: k44dnvso10