esa MCP Server

官方

esa.io 的官方模型上下文协议(MCP)服务器——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

License: MIT

日本語 | English

esa.io 的官方 Model Context Protocol (MCP) 服务器 - STDIO 传输版本。

概述

此 MCP 服务器可在 AI 助手与 esa.io 这一协作文档平台之间实现无缝集成。它使 AI 助手能够通过 Model Context Protocol 直接读取、创建、更新和管理 esa 文档。

可用工具

团队管理

  • esa_get_teams - 获取用户可访问的 esa 团队
  • esa_get_team_stats - 获取团队统计信息(成员、帖子、评论、星标、关注和活跃用户)
  • esa_get_team_tags - 获取团队帖子中使用的所有标签及其数量
  • esa_get_team_members - 获取团队成员及其角色和个人资料信息

帖子管理

  • esa_search_posts - 搜索 esa.io 中的帖子
  • esa_get_post - 按帖子编号获取指定帖子(包含 backlinks_count 和 body_md_stats,分别表示正文的字符数和行数)
  • esa_get_post_backlinks - 分页列出引用指定帖子的帖子
  • esa_create_post - 创建带有标签、类别和 WIP 状态的新帖子
  • esa_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 - 按 ID 获取指定评论
  • esa_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 帖子和评论中获取附件文件
    • 对小于 30MB 的受支持图片(JPEG、PNG、GIF、WebP)返回 base64 编码数据
    • 对其他文件类型、较大的图片,或指定 forceSignedUrl 时,返回签名 URL(有效期为 5 分钟)

帮助与文档

  • esa_get_search_options_help - 获取 esa 搜索语法文档
  • esa_get_markdown_syntax_help - 获取 esa Markdown 语法文档
  • esa_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 团队用 ❤️ 制作