File Writer MCP Server

Eine Node.js-Implementierung des Model Context Protocol (MCP), die für nahtlose Dateioperationen innerhalb von LM Studio und anderen MCP-kompatiblen Umgebungen entwickelt wurde. Dieser Server bietet eine robuste Schnittstelle für große Sprachmodelle zum Erstellen, Anhängen und Verwalten von Dateien in verschiedenen Formaten, einschließlich Plain Text, Markdown, CSV und Microsoft Excel (XLSX).

Funktionen

• Unterstützung mehrerer Formate: Verarbeitet Datentransformationen für .txt-, .md-, .csv- und .xlsx-Dateien.

• Strukturierte Datenverarbeitung: Akzeptiert Tabellendaten als JSON-Objekte und konvertiert diese automatisch in das gewünschte Format.

• Flexible Schreibmodi:

  • Anhängen (Standard): Fügt neue Daten an das Ende bestehender Dateien an.

  • Überschreiben: Ersetzt bestehende Dateien durch neue Inhalte.

  • Nummerierte Sicherung: Bewahrt bestehende Daten durch Erstellen inkrementierter Versionen (z. B. file.1.csv).

• Sicherheitsfokus: Beschränkt alle Dateioperationen auf ein vom Benutzer angegebenes Stammverzeichnis, um unbefugte Pfad-Traversierung zu verhindern.

• Excel-Integration: Nutzt ExcelJS für die hochpräzise Generierung von binären Tabellenkalkulationsdateien.

Related MCP server: Excel MCP Server

Installation

Voraussetzungen

• Node.js (v18 oder höher)

• npm

Einrichtung

1. Klonen Sie das Repository oder kopieren Sie die Quelldateien auf Ihren lokalen Computer.

2. Installieren Sie die erforderlichen Abhängigkeiten:

   npm install

3. Erstellen Sie das Projekt:

   npm run build

Konfiguration für LM Studio

Um diesen Server in LM Studio zu verwenden, fügen Sie ihn mit der folgenden Konfiguration zu Ihren MCP-Einstellungen hinzu:

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

Argumente

• --root <path>: (Erforderlich) Der absolute Pfad zum Standardverzeichnis für relative Dateioperationen.

• --overwrite: (Optional/Legacy) Wird aus Kompatibilitätsgründen für ältere Konfigurationen bereitgestellt; wird zugunsten der Werkzeugauswahl ignoriert.

• --backup: (Optional/Legacy) Wird aus Kompatibilitätsgründen für ältere Konfigurationen bereitgestellt; wird zugunsten der Werkzeugauswahl ignoriert.

Werkzeugnutzung

Der Server bietet drei verschiedene Werkzeuge, mit denen Sie die Dateiverwaltung direkt über die LM Studio-Seitenleiste steuern können:

1. write_file: Verwenden Sie dies für Standardoperationen. Es hängt Daten an bestehende Dateien an oder erstellt sie, falls sie nicht existieren.

2. write_file_overwrite: Verwenden Sie dies, um eine bestehende Datei vollständig durch neue Daten zu ersetzen.

3. write_file_backup: Verwenden Sie dies, um Daten zu speichern und gleichzeitig das Original zu bewahren. Wenn die Datei existiert, wird eine nummerierte Sicherung erstellt (z. B. data.1.csv).

Werkzeugargumente

• path (string): Der Dateiname oder der vollständige absolute Pfad. Wenn ein relativer Pfad angegeben wird, wird dieser relativ zum --root-Verzeichnis aufgelöst. Wenn ein absoluter Pfad angegeben wird, schreibt der Server direkt an diesen Ort.

• format (string): Die gewünschte Dateiendung (txt, md, csv oder xlsx).

• data (object):

  • headers (string[]): Spaltennamen für Tabellenformate.

  • rows (any[][]): Der zu schreibende Datensatz.

  • content (string, optional): Klartextinhalt für .txt-Dateien.

Entwicklung

Tests ausführen

Das Projekt verwendet Vitest für Unit-Tests. Um die Testsuite auszuführen:

npm test

Erstellen

Um den TypeScript-Quellcode in das Distributionsverzeichnis zu kompilieren:

npm run build

Lizenz

Dieses Projekt wird wie besehen für die Integration mit LM Studio und anderen MCP-Clients bereitgestellt.