esa MCP Server
chính thứcMáy chủ Giao thức Ngữ cảnh Mô hình (MCP) chính thức cho esa.io - phiên bản truyền tải STDIO.
Bạn có thể làm gì với Esa MCP?
- Tìm kiếm và đọc bài viết — Tìm bài viết bằng
esa_search_posts, sau đó lấy một bài cụ thể theo số bằngesa_get_postđể xem số lượng backlink và thống kê nội dung. - Tạo và chỉnh sửa nội dung — Tạo bài viết bằng
esa_create_post, cập nhật bằngesa_update_post, hoặc thêm văn bản vào đầu và cuối bằngesa_append_postvàesa_prepend_post. - Quản lý vòng đời bài viết — Đăng bài bằng
esa_ship_post, lưu trữ bằngesa_archive_post, sao chép bằngesa_duplicate_posthoặc khôi phục về một phiên bản trước đó. - Xử lý bình luận — Liệt kê bình luận trên một bài viết hoặc trong một nhóm, sau đó tạo, cập nhật hoặc xóa chúng bằng
esa_create_comment,esa_update_commentvàesa_delete_comment. - Khám phá danh mục và nhóm — Duyệt các đường dẫn danh mục bằng
esa_get_all_category_pathsvà kiểm tra thông tin chi tiết của nhóm bằngesa_get_team_statsvàesa_get_team_members. - Tóm tắt bài viết — Dùng prompt
esa_summarize_postđể nhận bản tóm tắt có cấu trúc về bài viết của một nhóm nhất định.
Tài liệu
esa MCP Server
日本語 | Tiếng Anh
Máy chủ Model Context Protocol (MCP) chính thức cho esa.io - phiên bản truyền tải STDIO.
Tổng quan
Máy chủ MCP này cung cấp khả năng tích hợp liền mạch giữa các trợ lý AI và esa.io, một nền tảng tài liệu cộng tác. Máy chủ cho phép các trợ lý AI đọc, tạo, cập nhật và quản lý tài liệu esa trực tiếp thông qua Model Context Protocol.
Công cụ hiện có
Quản lý nhóm
esa_get_teams- Lấy các nhóm esa mà người dùng có thể truy cậpesa_get_team_stats- Lấy thống kê nhóm (thành viên, bài đăng, bình luận, lượt đánh dấu sao, lượt theo dõi, người dùng hoạt động)esa_get_team_tags- Lấy tất cả thẻ được sử dụng trong bài đăng của nhóm cùng số lượngesa_get_team_members- Lấy thành viên nhóm cùng vai trò và thông tin hồ sơ
Quản lý bài đăng
esa_search_posts- Tìm kiếm bài đăng trên esa.ioesa_get_post- Lấy một bài đăng cụ thể theo số bài đăng (bao gồmbacklinks_countvàbody_md_statsvới số ký tự và số dòng trong nội dung)esa_get_post_backlinks- Liệt kê các bài đăng tham chiếu đến một bài đăng cụ thể, có phân trangesa_create_post- Tạo bài đăng mới với thẻ, danh mục và trạng thái WIPesa_update_post- Cập nhật bài đăng hiện có (tiêu đề, nội dung, thẻ, danh mục, trạng thái WIP)esa_append_post- Thêm nội dung vào cuối phần thân bài đăng (không cần lấy nội dung hiện tại; được lưu thành bản sửa đổi mới)esa_prepend_post- Thêm nội dung vào đầu phần thân bài đăng (không cần lấy nội dung hiện tại; được lưu thành bản sửa đổi mới)
Thao tác với bài đăng
esa_archive_post- Lưu trữ bài đăng bằng cách chuyển bài đăng vào danh mục Archived/esa_ship_post- Hoàn tất bài đăng (đánh dấu là hoàn tất bằng cách đặt wip thành false)esa_duplicate_post- Sao chép bài đăng (tạo bài đăng WIP mới với cùng tiêu đề và nội dung; cũng hỗ trợ sao chép giữa các nhóm)esa_rollback_post_revision- Khôi phục bài đăng về một bản sửa đổi được chỉ định (nội dung được khôi phục sẽ được lưu thành bản sửa đổi mới; kiểm tra số bản sửa đổi quarevision_numbertrongesa_get_post)
Quản lý bình luận
esa_get_comment- Lấy bình luận cụ thể theo IDesa_create_comment- Tạo bình luận mới trên bài đăngesa_update_comment- Cập nhật bình luận hiện cóesa_delete_comment- Xóa bình luậnesa_get_post_comments- Lấy bình luận của một bài đăng cụ thể, có phân trangesa_get_team_comments- Lấy bình luận của nhóm, có phân trang
Quản lý danh mục
esa_get_categories- Lấy danh mục và danh mục con cho một đường dẫn cụ thểesa_get_top_categories- Lấy tất cả danh mục cấp cao nhất của một nhómesa_get_all_category_paths- Lấy tất cả đường dẫn danh mục trong một nhóm (kèm số lượng bài đăng, hỗ trợ lọc)- Rất hữu ích để tìm hiểu cấu trúc danh mục, lập kế hoạch tổ chức và dọn dẹp
- Ví dụ về bộ lọc:
prefix: "dev"cho nội dung liên quan đến phát triển,match: "api"cho danh mục liên quan đến API
Tệp đính kèm
esa_get_attachment- Truy xuất tệp đính kèm từ bài đăng và bình luận trên esa- Trả về dữ liệu được mã hóa base64 cho các hình ảnh được hỗ trợ (JPEG, PNG, GIF, WebP) có dung lượng dưới 30MB
- Trả về URL có chữ ký (có hiệu lực trong 5 phút) cho các loại tệp khác, hình ảnh lớn hơn hoặc khi chỉ định forceSignedUrl
Trợ giúp và tài liệu
esa_get_search_options_help- Lấy tài liệu về cú pháp tìm kiếm của esaesa_get_markdown_syntax_help- Lấy tài liệu về cú pháp Markdown của esaesa_search_help- Tìm kiếm tài liệu esa về các tính năng và thuật ngữ
Tài nguyên hiện có
esa_recent_posts- Lấy các bài đăng được cập nhật gần đây từ nhóm esa- Mẫu:
esa://teams/{teamName}/posts/recent - Trả về: Danh sách JSON gồm các bài đăng được cập nhật gần đây
- Mẫu:
Prompt hiện có
esa_summarize_post- Tóm tắt nội dung bài đăng esa- Đầu vào: Tên nhóm và số bài đăng
- Đầu ra: Bản tóm tắt có cấu trúc về nội dung bài đăng
Cấu hình ứng dụng khách MCP
Thêm vào tệp cấu hình ứng dụng khách MCP của bạn:
Biến môi trường bắt buộc
- ESA_ACCESS_TOKEN: Mã thông báo truy cập
- Phạm vi bắt buộc:
read writehoặcadmin:comment read:post write:post read:category read:tag read:attachment read:team read:member - Khuyến nghị sử dụng PAT v2.
- Phạm vi bắt buộc:
- LANG: Ngôn ngữ giao diện người dùng
Ví dụ về Claude Desktop
Thêm vào claude_desktop_config.json:
Tùy chọn 1: Docker (Khuyến nghị)
{
"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"
}
}
}
}
Tùy chọn 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"
}
}
}
}
Lưu ý: Thay
/path/to/your/nodebằng kết quả của lệnhwhich node.
Registry
Gói này cung cấp registry.json tại thư mục gốc của gói, chứa các công cụ, tài nguyên và prompt đã đăng ký. Có thể sử dụng theo cách lập trình mà không cần khởi chạy máy chủ:
import registry from "@esaio/esa-mcp-server/registry.json" with {
type: "json",
};
Lược đồ:
{
"tools": [{ "name": "esa_get_teams" }, "..."],
"resources": [
{
"name": "esa_recent_posts",
"uriTemplate": "esa://teams/{teamName}/posts/recent"
}
],
"prompts": [{ "name": "esa_summarize_post" }]
}
Tệp được tạo lại bởi npm run build:registry và một bước kiểm tra CI đảm bảo tệp luôn đồng bộ với tập hợp đã đăng ký.
Liên kết
- esa.io - Nền tảng tài liệu cộng tác
- Model Context Protocol - Tìm hiểu thêm về MCP
- Tài liệu API - Tài liệu tham khảo API của esa.io
- Claude Desktop - Trợ lý AI hỗ trợ MCP
Hỗ trợ
- 📧 Hỗ trợ: Biểu mẫu phản hồi
- 🐛 Sự cố: Sự cố trên GitHub
- 📖 Trợ giúp: Tài liệu esa
Được tạo bằng ❤️ bởi nhóm esa