DeepWriter MCP Server

Ein Model Context Protocol (MCP)-Server für die Interaktion mit der DeepWriter-API. Dieser Server bietet Tools zum Erstellen, Verwalten und Generieren von Inhalten für DeepWriter-Projekte über die standardisierte MCP-Schnittstelle.

Merkmale

Projektmanagement : Projekte erstellen, auflisten, aktualisieren und löschen
Inhaltsgenerierung : Generieren Sie Inhalte für Projekte mithilfe der KI von DeepWriter
Projektdetails : Rufen Sie detaillierte Informationen zu Projekten ab
MCP-Integration : Nahtlose Integration mit Claude und anderen MCP-kompatiblen KI-Assistenten
Standard-MCP-Funktionen : Implementiert MCP-Protokollversion 2025-03-26
Transportunterstützung : Stdio-Transport für lokale Prozesskommunikation

Voraussetzungen

Node.js (v17 oder höher)
npm (v6 oder höher)
DeepWriter-API-Schlüssel
Ein MCP-kompatibler Client (z. B. Claude für Desktop)

Installation

Klonen Sie das Repository:
git clone https://github.com/yourusername/deepwriter-mcp.git cd deepwriter-mcp
Installieren Sie Abhängigkeiten:
npm install
Erstellen Sie mit Ihrem DeepWriter-API-Schlüssel eine .env Datei im Stammverzeichnis:
DEEPWRITER_API_KEY=your_api_key_here
Erstellen Sie das Projekt:
npm run build

Verwendung

Starten des Servers

Starten Sie den MCP-Server:

node build/index.js

Der Server wartet auf stdin auf MCP-Anfragen und antwortet auf stdout gemäß der MCP-stdio-Transportspezifikation.

Verbindung zu Claude für Desktop herstellen

So verwenden Sie den DeepWriter MCP-Server mit Claude für Desktop:

Öffnen Sie Ihre Claude for Desktop-Konfigurationsdatei:
- macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
- Windows: %APPDATA%\Claude\claude_desktop_config.json
Fügen Sie die Serverkonfiguration hinzu:
{ "mcpServers": { "deepwriter": { "command": "node", "args": ["/ABSOLUTE/PATH/TO/deepwriter-mcp/build/index.js"], "env": { "DEEPWRITER_API_KEY": "your_api_key_here" } } } }
Starten Sie Claude für Desktop neu, um die neue Konfiguration zu laden.

MCP-Protokollunterstützung

Dieser Server implementiert das MCP-Protokoll Version 2025-03-26 mit den folgenden Funktionen:

Transport : Stdio-Transport für lokale Prozesskommunikation
Tools : Vollständige Unterstützung für alle DeepWriter-API-Operationen
Protokollierung : Strukturierte Protokollierung mit konfigurierbaren Ebenen

Verfügbare Tools

1. Projekte auflisten

Listet alle Projekte auf, die mit Ihrem DeepWriter-Konto verknüpft sind.

{
  "api_key": "your_api_key_here"
}

2. getProjectDetails

Ruft detaillierte Informationen zu einem bestimmten Projekt ab.

{
  "api_key": "your_api_key_here",
  "project_id": "your_project_id_here"
}

3. Projekt erstellen

Erstellt ein neues Projekt mit dem angegebenen Titel und der angegebenen E-Mail.

{
  "api_key": "your_api_key_here",
  "title": "Your Project Title",
  "email": "your_email@example.com"
}

4. Projekt aktualisieren

Aktualisiert ein vorhandenes Projekt mit den angegebenen Änderungen.

{
  "api_key": "your_api_key_here",
  "project_id": "your_project_id_here",
  "updates": {
    "title": "Updated Project Title",
    "prompt": "Updated project prompt",
    "author": "Updated author name",
    "email": "updated@email.com",
    "model": "Updated model name",
    "outline_text": "Updated outline",
    "style_text": "Updated style guide",
    "supplemental_info": "Updated additional information",
    "work_description": "Updated work description",
    "work_details": "Updated work details",
    "work_vision": "Updated work vision"
  }
}

5. Arbeit generieren

Generiert Inhalte für ein Projekt mithilfe der KI von DeepWriter.

{
  "api_key": "your_api_key_here",
  "project_id": "your_project_id_here",
  "is_default": true // Optional, defaults to true
}

6. Projekt löschen

Löscht ein Projekt.

{
  "api_key": "your_api_key_here",
  "project_id": "your_project_id_here"
}

Entwicklung

Projektstruktur

deepwriter-mcp/
├── src/
│   ├── index.ts              # Main entry point and MCP server setup
│   ├── api/
│   │   └── deepwriterClient.ts  # DeepWriter API client
│   └── tools/                # MCP tool implementations
│       ├── createProject.ts
│       ├── deleteProject.ts
│       ├── generateWork.ts
│       ├── getProjectDetails.ts
│       ├── listProjects.ts
│       └── updateProject.ts
├── build/                    # Compiled JavaScript output
├── test-deepwriter-tools.js  # Tool testing script
├── test-mcp-client.js       # MCP client testing script
└── tsconfig.json            # TypeScript configuration

Gebäude

npm run build

Dadurch wird der TypeScript-Code im build -Verzeichnis in JavaScript kompiliert.

Testen

Sie können den MCP-Server lokal mit den bereitgestellten Testskripten testen:

node test-mcp-client.js

oder

node test-deepwriter-tools.js

TypeScript-Konfiguration

Das Projekt verwendet TypeScript mit ES-Modulen und Node16-Modulauflösung. Wichtige TypeScript-Einstellungen:

{
  "compilerOptions": {
    "target": "ES2022",
    "module": "Node16",
    "moduleResolution": "Node16",
    "outDir": "./build",
    "strict": true
  }
}

Fehlerbehebung

Häufige Probleme

Probleme mit dem API-Schlüssel :
- Stellen Sie sicher, dass Ihr DeepWriter-API-Schlüssel in der .env Datei korrekt festgelegt ist
- Überprüfen Sie, ob der API-Schlüssel in den Tool-Argumenten korrekt übergeben wird
- Überprüfen Sie, ob der API-Schlüssel über die erforderlichen Berechtigungen verfügt
Verbindungsprobleme :
- Stellen Sie sicher, dass die DeepWriter-API von Ihrem Netzwerk aus zugänglich ist
- Überprüfen Sie, ob Firewall- oder Proxy-Einstellungen Verbindungen blockieren könnten.
- Überprüfen Sie, ob Ihre Netzwerkverbindung stabil ist
Probleme mit dem MCP-Protokoll :
- Stellen Sie sicher, dass Sie einen kompatiblen MCP-Client verwenden
- Überprüfen Sie, ob der stdio-Transport richtig konfiguriert ist
- Überprüfen Sie, ob der Client die Protokollversion 2025-03-26 unterstützt.
Parameterbenennung :
- Der Server unterstützt sowohl snake_case ( project_id ) als auch camelCase ( projectId ) Parameternamen
- Bei allen Parametern wird zwischen Groß- und Kleinschreibung unterschieden.
- Erforderliche Parameter dürfen nicht null oder undefiniert sein

Debuggen

Um ausführliche Protokolle zu erhalten, führen Sie den Server mit der Umgebungsvariable DEBUG aus:

DEBUG=deepwriter-mcp:* node build/index.js

Sie können die Protokolle von Claude für Desktop auch hier überprüfen:

macOS: ~/Library/Logs/Claude/mcp*.log
Windows: %APPDATA%\Claude\logs\mcp*.log

Beitragen

Wir freuen uns über Beiträge aus der Community! So können Sie helfen:

Probleme melden

Fehlerberichte
- Verwenden Sie den GitHub-Issue-Tracker
- Fügen Sie detaillierte Schritte zur Reproduktion des Fehlers hinzu
- Geben Sie Ihre Umgebungsdetails an (Node.js-Version, Betriebssystem usw.).
- Fügen Sie relevante Protokolle und Fehlermeldungen ein
- Verwenden Sie die bereitgestellte Fehlerberichtsvorlage
Funktionsanfragen
- Verwenden Sie den GitHub-Issue-Tracker mit dem Label „Verbesserung“
- Beschreiben Sie die Funktion und ihren Anwendungsfall klar
- Erklären Sie, welchen Nutzen es für das Projekt hat
- Verwenden Sie die bereitgestellte Vorlage für Funktionsanforderungen
Sicherheitsprobleme
- Bei Sicherheitslücken bitte KEIN öffentliches Problem erstellen
- Senden Sie stattdessen eine E-Mail an security@deewriter.com
- Wir arbeiten mit Ihnen zusammen, um die Schwachstelle zu beheben
- Wir befolgen verantwortungsvolle Offenlegungspraktiken

Pull Requests

Bevor es losgeht
- Überprüfen Sie vorhandene Probleme und PRs, um doppelte Arbeit zu vermeiden
- Bei größeren Änderungen öffnen Sie zunächst ein Problem, um es zu besprechen
- Lesen Sie unsere Kodierungsstandards und MCP-Implementierungsrichtlinien
Entwicklungsprozess
- Forken Sie das Repository
- Erstellen Sie einen neuen Zweig vom main
- Befolgen Sie unseren Programmierstil und unsere Konventionen
- Fügen Sie Tests für neue Funktionen hinzu
- Aktualisieren Sie die Dokumentation nach Bedarf
PR-Anforderungen
- Fügen Sie eine klare Beschreibung der Änderungen hinzu
- Linkbezogene Probleme
- Tests hinzufügen oder aktualisieren
- Dokumentation aktualisieren
- Befolgen Sie die Konventionen für Commit-Nachrichten
- Unterzeichnen Sie die Contributor License Agreement (CLA)
Code-Überprüfung
- Alle PRs erfordern mindestens eine Überprüfung
- Feedback zu Bewertungen ansprechen
- Halten Sie PRs fokussiert und in angemessener Größe
- Reagieren Sie auf Fragen und Kommentare

Entwicklungsrichtlinien

Codestil
- Befolgen Sie die Best Practices für TypeScript
- Verwenden Sie ESLint mit unserer Konfiguration
- Code mit Prettier formatieren
- Befolgen Sie die MCP-Protokollspezifikationen
Testen
- Schreiben Sie Unit-Tests für neue Funktionen
- Aufrechterhaltung oder Verbesserung der Testabdeckung
- Testen der MCP-Protokollkonformität
- Testen mit mehreren Node.js-Versionen
Dokumentation
- Aktualisieren Sie README.md für benutzerseitige Änderungen
- JSDoc-Kommentare für neuen Code hinzufügen
- API-Dokumentation aktualisieren
- Fügen Sie Beispiele für neue Funktionen ein
Commit-Nachrichten
- Befolgen Sie das herkömmliche Commit-Format
- Verweisen Sie gegebenenfalls auf Probleme
- Halten Sie Commits fokussiert und atomar
- Verwenden Sie klare, beschreibende Nachrichten

Hilfe bekommen

Treten Sie unserer Discord-Community bei
Überprüfen Sie die Dokumentation
Stellen Sie Fragen in GitHub-Diskussionen
Nehmen Sie an unseren monatlichen Mitarbeitergesprächen teil

Sicherheit

Der Server validiert alle Eingaben vor der Verarbeitung
API-Schlüssel werden nie protokolliert oder in Fehlermeldungen angezeigt.
Der stdio-Transport bietet Prozessisolierung
Alle externen API-Aufrufe verwenden HTTPS
Eingabevalidierung verhindert Injektionsangriffe

Lizenz

MIT

DeepWriter MCP Server

Integrations