esa MCP Server

officiel

Serveur officiel du Model Context Protocol (MCP) pour esa.io - version de transport STDIO.

Que pouvez-vous faire avec Esa MCP ?

  • Rechercher et lire des publications — Trouvez des publications avec esa_search_posts, puis récupérez-en une en particulier par son numéro avec esa_get_post pour consulter son nombre de backlinks et les statistiques de son contenu.
  • Créer et modifier du contenu — Créez des publications avec esa_create_post, mettez-les à jour avec esa_update_post, ou ajoutez du texte au début ou à la fin avec esa_append_post et esa_prepend_post.
  • Gérer le cycle de vie des publications — Publiez une publication avec esa_ship_post, archivez-la avec esa_archive_post, dupliquez-la avec esa_duplicate_post ou revenez à une révision antérieure.
  • Gérer les commentaires — Listez les commentaires d’une publication ou d’une équipe, puis créez-les, modifiez-les ou supprimez-les avec esa_create_comment, esa_update_comment et esa_delete_comment.
  • Explorer les catégories et les équipes — Parcourez les chemins des catégories avec esa_get_all_category_paths et consultez les détails d’une équipe avec esa_get_team_stats et esa_get_team_members.
  • Résumer une publication — Utilisez le prompt esa_summarize_post pour obtenir un résumé structuré d’une publication d’une équipe donnée.

Documentation

esa MCP Server

License: MIT

日本語 | English

Serveur officiel Model Context Protocol (MCP) pour esa.io — version avec transport STDIO.

Présentation

Ce serveur MCP assure une intégration fluide entre les assistants IA et esa.io, une plateforme collaborative de documentation. Il permet aux assistants IA de lire, créer, mettre à jour et gérer directement les documents esa via le Model Context Protocol.

Outils disponibles

Gestion des équipes

  • esa_get_teams - Obtenir les équipes esa auxquelles l’utilisateur a accès
  • esa_get_team_stats - Obtenir les statistiques de l’équipe (membres, publications, commentaires, étoiles, suivis, utilisateurs actifs)
  • esa_get_team_tags - Obtenir tous les tags utilisés dans les publications de l’équipe, avec leur nombre
  • esa_get_team_members - Obtenir les membres de l’équipe, leurs rôles et les informations de leur profil

Gestion des publications

  • esa_search_posts - Rechercher des publications sur esa.io
  • esa_get_post - Obtenir une publication spécifique par son numéro (inclut backlinks_count et body_md_stats avec le nombre de caractères et de lignes du corps)
  • esa_get_post_backlinks - Lister les publications qui font référence à une publication spécifique, avec pagination
  • esa_create_post - Créer une publication avec des tags, une catégorie et le statut WIP
  • esa_update_post - Mettre à jour une publication existante (titre, contenu, tags, catégorie, statut WIP)
  • esa_append_post - Ajouter du contenu à la fin du corps d’une publication (inutile de récupérer le corps actuel ; le contenu est enregistré comme une nouvelle révision)
  • esa_prepend_post - Ajouter du contenu au début du corps d’une publication (inutile de récupérer le corps actuel ; le contenu est enregistré comme une nouvelle révision)

Actions sur les publications

  • esa_archive_post - Archiver une publication en la déplaçant dans la catégorie Archived/
  • esa_ship_post - Publier une publication (la marquer comme terminée en définissant wip sur false)
  • esa_duplicate_post - Dupliquer une publication (créer une nouvelle publication WIP avec le même titre et le même corps ; la duplication entre équipes est également prise en charge)
  • esa_rollback_post_revision - Restaurer une publication à une révision spécifiée (le contenu restauré est enregistré comme une nouvelle révision ; vérifier le numéro de révision via revision_number dans esa_get_post)

Gestion des commentaires

  • esa_get_comment - Obtenir un commentaire spécifique par son ID
  • esa_create_comment - Créer un commentaire sur une publication
  • esa_update_comment - Mettre à jour un commentaire existant
  • esa_delete_comment - Supprimer un commentaire
  • esa_get_post_comments - Obtenir les commentaires d’une publication spécifique, avec pagination
  • esa_get_team_comments - Obtenir les commentaires de l’équipe, avec pagination

Gestion des catégories

  • esa_get_categories - Obtenir les catégories et sous-catégories d’un chemin spécifique
  • esa_get_top_categories - Obtenir toutes les catégories de premier niveau d’une équipe
  • esa_get_all_category_paths - Obtenir tous les chemins de catégories d’une équipe (avec le nombre de publications, filtrage pris en charge)
    • Idéal pour comprendre la structure des catégories, planifier l’organisation et effectuer un nettoyage
    • Exemples de filtres : prefix: "dev" pour les catégories liées au développement, match: "api" pour celles liées aux API

Pièces jointes

  • esa_get_attachment - Récupérer un fichier joint depuis les publications et commentaires esa
    • Renvoie des données encodées en base64 pour les images prises en charge (JPEG, PNG, GIF, WebP) de moins de 30 Mo
    • Renvoie des URL signées (valides pendant 5 minutes) pour les autres types de fichiers, les images plus volumineuses ou lorsque forceSignedUrl est spécifié

Aide et documentation

  • esa_get_search_options_help - Obtenir la documentation sur la syntaxe de recherche esa
  • esa_get_markdown_syntax_help - Obtenir la documentation sur la syntaxe Markdown d’esa
  • esa_search_help - Rechercher dans la documentation esa des informations sur les fonctionnalités et la terminologie

Ressources disponibles

  • esa_recent_posts - Récupérer les publications récemment mises à jour d’une équipe esa
    • Modèle : esa://teams/{teamName}/posts/recent
    • Renvoie : liste JSON des publications récemment mises à jour

Prompts disponibles

  • esa_summarize_post - Résumer le contenu d’une publication esa
    • Entrée : nom de l’équipe et numéro de la publication
    • Sortie : résumé structuré du contenu de la publication

Configuration du client MCP

Ajoutez ces éléments au fichier de configuration de votre client MCP :

Variables d’environnement requises

  • ESA_ACCESS_TOKEN : jeton d’accès
    • Portées requises : read write ou admin:comment read:post write:post read:category read:tag read:attachment read:team read:member
    • PAT v2 est recommandé.
  • LANG : langue de l’interface utilisateur

Exemple pour Claude Desktop

Ajoutez à claude_desktop_config.json :

Option 1 : Docker (recommandé)

{
  "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"
      }
    }
  }
}

Remarque : remplacez /path/to/your/node par le résultat de la commande which node.

Registre

Ce package inclut registry.json à la racine du package, qui expose les outils, ressources et prompts enregistrés. Il peut être utilisé par programmation sans lancer le serveur :

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

Schéma :

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

Le fichier est régénéré par npm run build:registry et une vérification CI garantit qu’il reste synchronisé avec l’ensemble enregistré.

Liens

Assistance


Créé avec ❤️ par l’équipe esa