MCP-сервер для записи файлов

Реализация протокола Model Context Protocol (MCP) на Node.js, разработанная для беспрепятственных операций с файлами в LM Studio и других средах, совместимых с MCP. Этот сервер предоставляет надежный интерфейс для больших языковых моделей для создания, дополнения и управления файлами в различных форматах, включая обычный текст, Markdown, CSV и Microsoft Excel (XLSX).

Возможности

• Поддержка нескольких форматов: Обработка преобразования данных для файлов .txt, .md, .csv и .xlsx.

• Обработка структурированных данных: Принимает табличные данные в виде объектов JSON и автоматически преобразует их в требуемый формат.

• Гибкие режимы записи:

  • Добавление (по умолчанию): Добавляет новые данные в конец существующих файлов.

  • Перезапись: Заменяет существующие файлы новым содержимым.

  • Нумерованное резервное копирование: Сохраняет существующие данные путем создания версий с инкрементом (например, file.1.csv).

• Фокус на безопасности: Ограничивает все операции с файлами указанным пользователем корневым каталогом для предотвращения несанкционированного обхода путей.

• Интеграция с Excel: Использует ExcelJS для высококачественного создания бинарных файлов электронных таблиц.

Related MCP server: Excel MCP Server

Установка

Предварительные требования

• Node.js (v18 или выше)

• npm

Настройка

1. Клонируйте репозиторий или скопируйте исходные файлы на свой локальный компьютер.

2. Установите необходимые зависимости:

   npm install

3. Соберите проект:

   npm run build

Конфигурация для LM Studio

Чтобы использовать этот сервер в LM Studio, добавьте его в настройки MCP со следующей конфигурацией:

{
  "mcpServers": {
    "file-writer": {
      "command": "node",
      "args": [
        "C:/Users/szpon/file_writer_mcp/dist/index.js",
        "--root",
        "C:/your/default/directory"
      ]
    }
  }
}

Аргументы

• --root <path>: (Обязательно) Абсолютный путь к каталогу по умолчанию для относительных операций с файлами.

• --overwrite: (Необязательно/Устаревший) Предоставлен для совместимости со старыми конфигурациями; игнорируется в пользу выбора инструмента.

• --backup: (Необязательно/Устаревший) Предоставлен для совместимости со старыми конфигурациями; игнорируется в пользу выбора инструмента.

Использование инструментов

Сервер предоставляет три различных инструмента, чтобы дать вам четкий контроль над обработкой файлов прямо из боковой панели LM Studio:

1. write_file: Используйте это для стандартных операций. Добавляет данные в существующие файлы или создает их, если они не существуют.

2. write_file_overwrite: Используйте это для полной замены существующего файла новыми данными.

3. write_file_backup: Используйте это для сохранения данных с сохранением оригинала. Если файл существует, создается нумерованная резервная копия (например, data.1.csv).

Аргументы инструментов

• path (строка): Имя файла или полный абсолютный путь. Если указан относительный путь, он разрешается относительно каталога --root. Если указан абсолютный путь, сервер записывает данные непосредственно в это место.

• format (строка): Желаемое расширение файла (txt, md, csv или xlsx).

• data (объект):

  • headers (string[]): Имена столбцов для табличных форматов.

  • rows (any[][]): Набор данных для записи.

  • content (строка, необязательно): Обычное текстовое содержимое для файлов .txt.

Разработка

Запуск тестов

Проект использует Vitest для модульного тестирования. Чтобы выполнить набор тестов:

npm test

Сборка

Чтобы скомпилировать исходный код TypeScript в каталог дистрибутива:

npm run build

Лицензия

Этот проект предоставляется «как есть» для интеграции с LM Studio и другими MCP-клиентами.