esa MCP Server

offiziell

Offizieller Model Context Protocol (MCP) Server für esa.io - STDIO-Transport-Version.

Was kann man mit Esa MCP machen?

  • Beiträge suchen und lesen — Finde Beiträge mit esa_search_posts und rufe anschließend einen bestimmten Beitrag anhand seiner Nummer mit esa_get_post ab, um die Anzahl seiner Backlinks und Statistiken zum Inhalt anzuzeigen.
  • Inhalte erstellen und bearbeiten — Erstelle Beiträge mit esa_create_post, aktualisiere sie mit esa_update_post oder füge Text mit esa_append_post und esa_prepend_post am Ende oder Anfang hinzu.
  • Beitragslebenszyklus verwalten — Veröffentliche einen Beitrag mit esa_ship_post, archiviere ihn mit esa_archive_post, dupliziere ihn mit esa_duplicate_post oder setze ihn auf eine frühere Version zurück.
  • Kommentare verwalten — Liste Kommentare zu einem Beitrag oder Team auf und erstelle, aktualisiere oder lösche sie anschließend mit esa_create_comment, esa_update_comment und esa_delete_comment.
  • Kategorien und Teams erkunden — Durchsuche Kategoriepfade mit esa_get_all_category_paths und prüfe Teamdetails mit esa_get_team_stats und esa_get_team_members.
  • Einen Beitrag zusammenfassen — Verwende den Prompt esa_summarize_post, um eine strukturierte Zusammenfassung eines Beitrags eines bestimmten Teams zu erhalten.

Dokumentation

esa MCP Server

License: MIT

日本語 | English

Offizieller Model Context Protocol (MCP)-Server für esa.io – Version mit STDIO-Transport.

Übersicht

Dieser MCP-Server ermöglicht eine nahtlose Integration zwischen KI-Assistenten und esa.io, einer kollaborativen Dokumentationsplattform. Er ermöglicht KI-Assistenten, esa-Dokumente direkt über das Model Context Protocol zu lesen, zu erstellen, zu aktualisieren und zu verwalten.

Verfügbare Tools

Teamverwaltung

  • esa_get_teams – Zugängliche esa-Teams des Benutzers abrufen
  • esa_get_team_stats – Teamstatistiken abrufen (Mitglieder, Beiträge, Kommentare, Sterne, Beobachtungen, aktive Benutzer)
  • esa_get_team_tags – Alle in Teambeiträgen verwendeten Tags mit Anzahl abrufen
  • esa_get_team_members – Teammitglieder mit Rollen und Profilinformationen abrufen

Beitragsverwaltung

  • esa_search_posts – Beiträge in esa.io suchen
  • esa_get_post – Einen bestimmten Beitrag anhand der Beitragsnummer abrufen (einschließlich backlinks_count und body_md_stats mit Zeichen- und Zeilenanzahl des Inhalts)
  • esa_get_post_backlinks – Beiträge mit Paginierung auflisten, die auf einen bestimmten Beitrag verweisen
  • esa_create_post – Einen neuen Beitrag mit Tags, Kategorie und WIP-Status erstellen
  • esa_update_post – Einen bestehenden Beitrag aktualisieren (Titel, Inhalt, Tags, Kategorie, WIP-Status)
  • esa_append_post – Inhalt am Ende des Beitragsinhalts anhängen (der aktuelle Inhalt muss nicht abgerufen werden; wird als neue Revision gespeichert)
  • esa_prepend_post – Inhalt am Anfang des Beitragsinhalts einfügen (der aktuelle Inhalt muss nicht abgerufen werden; wird als neue Revision gespeichert)

Beitragsaktionen

  • esa_archive_post – Einen Beitrag archivieren, indem er in die Kategorie Archived/ verschoben wird
  • esa_ship_post – Einen Beitrag abschließen (als abgeschlossen markieren, indem wip auf false gesetzt wird)
  • esa_duplicate_post – Einen Beitrag duplizieren (einen neuen WIP-Beitrag mit demselben Titel und Inhalt erstellen; auch teamübergreifendes Duplizieren wird unterstützt)
  • esa_rollback_post_revision – Einen Beitrag auf eine angegebene Revision zurücksetzen (der wiederhergestellte Inhalt wird als neue Revision gespeichert; die Revisionsnummer über revision_number in esa_get_post prüfen)

Kommentarverwaltung

  • esa_get_comment – Einen bestimmten Kommentar anhand der ID abrufen
  • esa_create_comment – Einen neuen Kommentar zu einem Beitrag erstellen
  • esa_update_comment – Einen bestehenden Kommentar aktualisieren
  • esa_delete_comment – Einen Kommentar löschen
  • esa_get_post_comments – Kommentare zu einem bestimmten Beitrag mit Paginierung abrufen
  • esa_get_team_comments – Teamkommentare mit Paginierung abrufen

Kategorienverwaltung

  • esa_get_categories – Kategorien und Unterkategorien für einen bestimmten Pfad abrufen
  • esa_get_top_categories – Alle Kategorien der obersten Ebene für ein Team abrufen
  • esa_get_all_category_paths – Alle Kategoriepfade in einem Team abrufen (mit Beitragsanzahl, Filterung wird unterstützt)
    • Ideal, um die Kategorienstruktur zu verstehen, die Organisation zu planen und aufzuräumen
    • Filterbeispiele: prefix: "dev" für entwicklungsbezogene Kategorien, match: "api" für API-bezogene Kategorien

Anhänge

  • esa_get_attachment – Eine Anhangdatei aus esa-Beiträgen und Kommentaren abrufen
    • Gibt base64-codierte Daten für unterstützte Bilder (JPEG, PNG, GIF, WebP) unter 30 MB zurück
    • Gibt signierte URLs (5 Minuten gültig) für andere Dateitypen, größere Bilder oder bei Angabe von forceSignedUrl zurück

Hilfe und Dokumentation

  • esa_get_search_options_help – Dokumentation zur esa-Suchsyntax abrufen
  • esa_get_markdown_syntax_help – Dokumentation zur esa-Markdown-Syntax abrufen
  • esa_search_help – esa-Dokumentation nach Funktionen und Begriffen durchsuchen

Verfügbare Ressourcen

  • esa_recent_posts – Zuletzt aktualisierte Beiträge aus einem esa-Team abrufen
    • Vorlage: esa://teams/{teamName}/posts/recent
    • Gibt eine JSON-Liste kürzlich aktualisierter Beiträge zurück

Verfügbare Prompts

  • esa_summarize_post – Inhalt eines esa-Beitrags zusammenfassen
    • Eingabe: Teamname und Beitragsnummer
    • Ausgabe: Strukturierte Zusammenfassung des Beitragsinhalts

MCP-Client-Konfiguration

Füge Folgendes zur Konfigurationsdatei deines MCP-Clients hinzu:

Erforderliche Umgebungsvariablen

  • ESA_ACCESS_TOKEN: Zugriffstoken
    • Erforderliche Berechtigungsbereiche: read write oder admin:comment read:post write:post read:category read:tag read:attachment read:team read:member
    • PAT v2 wird empfohlen.
  • LANG: Sprache der Benutzeroberfläche

Beispiel für Claude Desktop

Füge Folgendes zu claude_desktop_config.json hinzu:

Option 1: Docker (empfohlen)

{
  "mcpServers": {
    "esa": {
      "command": "docker",
      "args": [
        "run",
        "-i",
        "--rm",
        "-e",
        "ESA_ACCESS_TOKEN",
        "-e",
        "LANG",
        "ghcr.io/esaio/esa-mcp-server"
      ],
      "env": {
        "ESA_ACCESS_TOKEN": "your_personal_access_token",
        "LANG": "en"
      }
    }
  }
}

Option 2: npx

{
  "mcpServers": {
    "esa": {
      "command": "/Users/your-username/.nodenv/shims/npx",
      "args": ["@esaio/esa-mcp-server"],
      "env": {
        "ESA_ACCESS_TOKEN": "your_personal_access_token",
        "LANG": "en"
      }
    }
  }
}

Hinweis: Ersetze /path/to/your/node durch die Ausgabe des Befehls which node.

Registry

Dieses Paket enthält registry.json im Paketstammverzeichnis, das registrierte Tools, Ressourcen und Prompts bereitstellt. Es kann programmgesteuert verwendet werden, ohne den Server zu starten:

import registry from "@esaio/esa-mcp-server/registry.json" with {
  type: "json",
};

Schema:

{
  "tools": [{ "name": "esa_get_teams" }, "..."],
  "resources": [
    {
      "name": "esa_recent_posts",
      "uriTemplate": "esa://teams/{teamName}/posts/recent"
    }
  ],
  "prompts": [{ "name": "esa_summarize_post" }]
}

Die Datei wird von npm run build:registry neu generiert. Eine CI-Prüfung stellt sicher, dass sie mit der registrierten Menge synchron bleibt.

Links

Support


Mit ❤️ vom esa-Team erstellt