关于 esa
esa 是连接 AI 助手与 esa.io 团队文档服务的官方 MCP 服务,可搜索、读取、创建、编辑和整理文章、评论及团队信息。
主要功能
- 01搜索和读取文章
- 02创建、编辑及追加文章内容
- 03归档、复制、发布及回滚文章
- 04管理评论、分类和附件
- 05获取团队成员、标签和统计信息
- 06提供近期文章资源与文章摘要提示词
适用场景
- 01查找和审阅团队文档
- 02通过 AI 助手起草或更新 esa 文章
- 03管理评论并整理分类
- 04总结文章或查看团队动态
MCP 相关
通过 MCP 工具提供 esa 团队、文章、评论、分类、附件和帮助操作,并提供近期文章资源与文章摘要提示词。使用 STDIO 传输。
配置
本地服务的配置在各客户端中通用,复制后粘贴到客户端的 MCP 配置文件即可。
工具
28收录的工具列表 · 更新于 2 周前
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| page | number | 否 | 页码(从 1 开始) |
| role | enum | 否 | 按角色筛选member | owner |
| perPage | number | 否 | 每页项目数 |
详细介绍
esa MCP 服务
日本語 | English
esa.io 官方 MCP(Model Context Protocol)服务(STDIO Transport 版)
概述
这是一个连接 AI 助手与信息共享服务 esa 的 MCP 服务。通过 Model Context Protocol,AI 助手可以读取 esa 文章,也可以创建、更新和管理文章。
可用工具
团队管理
esa_get_teams- 已加入的 esa 团队列表esa_get_team_stats- 团队统计信息(成员数、文章数、评论数等)esa_get_team_tags- 团队中使用的标签及其使用次数esa_get_team_members- 团队成员及其角色和个人资料
文章管理
esa_search_posts- 搜索文章esa_get_post- 根据文章 ID 获取文章(包含反向链接总数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 状态并公开)esa_duplicate_post- 复制文章(创建标题和正文相同的 WIP 文章,也可复制到其他团队)esa_rollback_post_revision- 将文章回滚到指定修订版本(恢复的内容将保存为新修订版本。可通过esa_get_post的revision_number查看修订版本号)
评论管理
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- 获取文章或评论的附件- 对于支持的格式(JPEG、PNG、GIF、WebP)且大小不超过 30 MB 的图片,以 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://teams/{teamName}/posts/recent - 返回值:最近更新的文章 JSON 列表
- 模板:
提示词
esa_summarize_post- 总结 esa 文章- 输入:团队名称和文章 ID
- 输出:文章的结构化摘要
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:UI 语言设置
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": "ja"
}
}
}
}
选项 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": "ja"
}
}
}
}
注意:请将
/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" }]
}
registry.json 由 npm run build:registry 生成。如果生成内容与注册内容不一致,CI 会失败。
链接
- esa.io - 信息共享服务 esa
- Model Context Protocol - MCP 详情
- API 文档 - esa API 参考
- Claude Desktop - 支持 MCP 的 AI 助手
支持
- 📧 支持:反馈表单
- 🐛 问题:GitHub Issues
- 📖 帮助:esa 文档
由 esa 团队用 ❤️ 制作
评论
支持 Markdown
一个开放协议,规定了 AI 应用如何以统一方式连接外部工具与数据源。客户端负责与模型对话,MCP 服务负责提供工具、资源和提示模板,两者通过标准消息通信,同一个服务可以被不同客户端复用。