esa MCP Server
offiziellOffizieller 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_postsund rufe anschließend einen bestimmten Beitrag anhand seiner Nummer mitesa_get_postab, um die Anzahl seiner Backlinks und Statistiken zum Inhalt anzuzeigen. - Inhalte erstellen und bearbeiten — Erstelle Beiträge mit
esa_create_post, aktualisiere sie mitesa_update_postoder füge Text mitesa_append_postundesa_prepend_postam Ende oder Anfang hinzu. - Beitragslebenszyklus verwalten — Veröffentliche einen Beitrag mit
esa_ship_post, archiviere ihn mitesa_archive_post, dupliziere ihn mitesa_duplicate_postoder 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_commentundesa_delete_comment. - Kategorien und Teams erkunden — Durchsuche Kategoriepfade mit
esa_get_all_category_pathsund prüfe Teamdetails mitesa_get_team_statsundesa_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
日本語 | 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 abrufenesa_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 abrufenesa_get_team_members– Teammitglieder mit Rollen und Profilinformationen abrufen
Beitragsverwaltung
esa_search_posts– Beiträge in esa.io suchenesa_get_post– Einen bestimmten Beitrag anhand der Beitragsnummer abrufen (einschließlichbacklinks_countundbody_md_statsmit Zeichen- und Zeilenanzahl des Inhalts)esa_get_post_backlinks– Beiträge mit Paginierung auflisten, die auf einen bestimmten Beitrag verweisenesa_create_post– Einen neuen Beitrag mit Tags, Kategorie und WIP-Status erstellenesa_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 wirdesa_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 überrevision_numberinesa_get_postprüfen)
Kommentarverwaltung
esa_get_comment– Einen bestimmten Kommentar anhand der ID abrufenesa_create_comment– Einen neuen Kommentar zu einem Beitrag erstellenesa_update_comment– Einen bestehenden Kommentar aktualisierenesa_delete_comment– Einen Kommentar löschenesa_get_post_comments– Kommentare zu einem bestimmten Beitrag mit Paginierung abrufenesa_get_team_comments– Teamkommentare mit Paginierung abrufen
Kategorienverwaltung
esa_get_categories– Kategorien und Unterkategorien für einen bestimmten Pfad abrufenesa_get_top_categories– Alle Kategorien der obersten Ebene für ein Team abrufenesa_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 abrufenesa_get_markdown_syntax_help– Dokumentation zur esa-Markdown-Syntax abrufenesa_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
- Vorlage:
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 writeoderadmin:comment read:post write:post read:category read:tag read:attachment read:team read:member - PAT v2 wird empfohlen.
- Erforderliche Berechtigungsbereiche:
- 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/nodedurch die Ausgabe des Befehlswhich 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
- esa.io – Die kollaborative Dokumentationsplattform
- Model Context Protocol – Weitere Informationen zu MCP
- API-Dokumentation – esa.io-API-Referenz
- Claude Desktop – KI-Assistent mit MCP-Unterstützung
Support
- 📧 Support: Feedback-Formular
- 🐛 Probleme: GitHub Issues
- 📖 Hilfe: esa Docs
Mit ❤️ vom esa-Team erstellt