esa MCP Server
официальныйОфициальный сервер протокола контекста модели (MCP) для esa.io — версия с транспортом STDIO.
Что можно делать с Esa MCP?
- Поиск и чтение публикаций — Найдите публикации с помощью
esa_search_posts, затем получите конкретную публикацию по номеру с помощьюesa_get_post, чтобы увидеть количество обратных ссылок и статистику по тексту. - Создание и редактирование контента — Создавайте публикации с помощью
esa_create_post, обновляйте их с помощьюesa_update_postили добавляйте текст в конец и начало с помощьюesa_append_postиesa_prepend_post. - Управление жизненным циклом публикаций — Опубликуйте публикацию с помощью
esa_ship_post, переместите её в архив с помощьюesa_archive_post, создайте её копию с помощьюesa_duplicate_postили вернитесь к более ранней версии. - Работа с комментариями — Просматривайте комментарии к публикации или команде, а затем создавайте, обновляйте или удаляйте их с помощью
esa_create_comment,esa_update_commentиesa_delete_comment. - Изучение категорий и команд — Просматривайте пути категорий с помощью
esa_get_all_category_pathsи проверяйте сведения о команде с помощьюesa_get_team_statsиesa_get_team_members. - Краткое изложение публикации — Используйте промпт
esa_summarize_post, чтобы получить структурированное краткое изложение публикации указанной команды.
Документация
esa MCP Server
日本語 | Английский
Официальный сервер Model Context Protocol (MCP) для esa.io — версия с транспортом STDIO.
Обзор
Этот MCP-сервер обеспечивает бесшовную интеграцию между ИИ-ассистентами и esa.io, платформой для совместной работы с документацией. Он позволяет ИИ-ассистентам читать, создавать, обновлять документы esa и управлять ими напрямую через Model Context Protocol.
Доступные инструменты
Управление командами
esa_get_teams— Получить список команд esa, доступных пользователюesa_get_team_stats— Получить статистику команды (участники, публикации, комментарии, отметки «Нравится», подписки, активные пользователи)esa_get_team_tags— Получить все теги, используемые в публикациях команды, с указанием количестваesa_get_team_members— Получить список участников команды с ролями и информацией профиля
Управление публикациями
esa_search_posts— Искать публикации в esa.ioesa_get_post— Получить публикацию по её номеру (включаяbacklinks_countиbody_md_statsс количеством символов и строк в тексте)esa_get_post_backlinks— Получить список публикаций, ссылающихся на указанную публикацию, с постраничной навигациейesa_create_post— Создать публикацию с тегами, категорией и статусом WIPesa_update_post— Обновить существующую публикацию (заголовок, содержимое, теги, категория, статус WIP)esa_append_post— Добавить содержимое в конец текста публикации (не нужно получать текущий текст; сохраняется как новая версия)esa_prepend_post— Добавить содержимое в начало текста публикации (не нужно получать текущий текст; сохраняется как новая версия)
Действия с публикациями
esa_archive_post— Архивировать публикацию, переместив её в категорию Archived/esa_ship_post— Завершить публикацию (установить wip в false)esa_duplicate_post— Дублировать публикацию (создать новую публикацию WIP с теми же заголовком и текстом; также поддерживается дублирование между командами)esa_rollback_post_revision— Откатить публикацию до указанной версии (восстановленное содержимое сохраняется как новая версия; номер версии можно проверить с помощьюrevision_numberвesa_get_post)
Управление комментариями
esa_get_comment— Получить комментарий по его IDesa_create_comment— Создать комментарий к публикацииesa_update_comment— Обновить существующий комментарийesa_delete_comment— Удалить комментарийesa_get_post_comments— Получить комментарии к публикации с постраничной навигациейesa_get_team_comments— Получить комментарии команды с постраничной навигацией
Управление категориями
esa_get_categories— Получить категории и подкатегории для указанного путиesa_get_top_categories— Получить все категории верхнего уровня командыesa_get_all_category_paths— Получить все пути категорий в команде (с количеством публикаций, поддерживается фильтрация)- Идеально подходит для изучения структуры категорий, планирования организации и очистки
- Примеры фильтров:
prefix: "dev"для категорий, связанных с разработкой,match: "api"для категорий, связанных с API
Вложения
esa_get_attachment— Получить файл вложения из публикаций и комментариев esa- Возвращает данные в кодировке base64 для поддерживаемых изображений (JPEG, PNG, GIF, WebP) размером менее 30 МБ
- Возвращает подписанные URL (действуют 5 минут) для других типов файлов, более крупных изображений или если указан forceSignedUrl
Справка и документация
esa_get_search_options_help— Получить документацию по синтаксису поиска esaesa_get_markdown_syntax_help— Получить документацию по синтаксису Markdown в esaesa_search_help— Искать в документации esa сведения о функциях и терминологии
Доступные ресурсы
esa_recent_posts— Получить недавно обновлённые публикации команды esa- Шаблон:
esa://teams/{teamName}/posts/recent - Возвращает: список недавно обновлённых публикаций в формате JSON
- Шаблон:
Доступные промпты
esa_summarize_post— Составить краткое содержание публикации esa- Входные данные: название команды и номер публикации
- Результат: структурированное краткое содержание публикации
Настройка клиента MCP
Добавьте в файл конфигурации клиента MCP:
Обязательные переменные окружения
- ESA_ACCESS_TOKEN: токен доступа
- Обязательные области доступа:
read writeилиadmin:comment read:post write:post read:category read:tag read:attachment read:team read:member - Рекомендуется использовать PAT v2.
- Обязательные области доступа:
- LANG: язык интерфейса
Пример для Claude Desktop
Добавьте в claude_desktop_config.json:
Вариант 1: Docker (рекомендуется)
{
"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"
}
}
}
}
Вариант 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"
}
}
}
}
Примечание: замените
/path/to/your/nodeрезультатом выполнения командыwhich node.
Реестр
Этот пакет включает registry.json в корневом каталоге пакета, где перечислены зарегистрированные инструменты, ресурсы и промпты. Его можно использовать программно, не запуская сервер:
import registry from "@esaio/esa-mcp-server/registry.json" with {
type: "json",
};
Схема:
{
"tools": [{ "name": "esa_get_teams" }, "..."],
"resources": [
{
"name": "esa_recent_posts",
"uriTemplate": "esa://teams/{teamName}/posts/recent"
}
],
"prompts": [{ "name": "esa_summarize_post" }]
}
Файл создаётся заново с помощью npm run build:registry, а проверка CI гарантирует, что он соответствует зарегистрированному набору.
Ссылки
- esa.io — платформа для совместной работы с документацией
- Model Context Protocol — подробнее о MCP
- Документация API — справочник по API esa.io
- Claude Desktop — ИИ-ассистент с поддержкой MCP
Поддержка
- 📧 Поддержка: Форма обратной связи
- 🐛 Проблемы: Проблемы на GitHub
- 📖 Справка: Документация esa
Создано с ❤️ командой esa