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
日本語 | 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- 將文章還原至指定修訂版本(還原的內容會儲存為新修訂版本;請透過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- 從 esa 文章和留言中擷取附件檔案- 支援的圖片(JPEG、PNG、GIF、WebP)若小於 30MB,會以 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
此套件在套件根目錄提供 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 Documentation - esa.io API 參考文件
- Claude Desktop - 支援 MCP 的 AI 助理
支援
- 📧 支援:意見回饋表單
- 🐛 問題:GitHub Issues
- 📖 說明:esa Docs
由 esa 團隊用 ❤️ 打造