esa MCP Server

ทางการ

เซิร์ฟเวอร์ Model Context Protocol (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

License: MIT

日本語 | English

เซิร์ฟเวอร์ Model Context Protocol (MCP) อย่างเป็นทางการสำหรับ esa.io - เวอร์ชันการขนส่งแบบ STDIO

ภาพรวม

เซิร์ฟเวอร์ MCP นี้ช่วยให้ผู้ช่วย AI ผสานการทำงานกับ esa.io ซึ่งเป็นแพลตฟอร์มเอกสารสำหรับการทำงานร่วมกันได้อย่างราบรื่น ผู้ช่วย AI สามารถอ่าน สร้าง อัปเดต และจัดการเอกสาร esa ได้โดยตรงผ่าน Model Context Protocol

เครื่องมือที่พร้อมใช้งาน

การจัดการทีม

  • 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
    • ส่งคืนข้อมูลที่เข้ารหัสแบบ base64 สำหรับรูปภาพที่รองรับ (JPEG, PNG, GIF, WebP) ซึ่งมีขนาดไม่เกิน 30MB
    • ส่งคืน URL ที่ลงนามแล้ว (ใช้ได้ 5 นาที) สำหรับไฟล์ประเภทอื่น รูปภาพขนาดใหญ่กว่า หรือเมื่อระบุ forceSignedUrl

ความช่วยเหลือและเอกสารประกอบ

  • esa_get_search_options_help - ดูเอกสารไวยากรณ์การค้นหาของ esa
  • esa_get_markdown_syntax_help - ดูเอกสารไวยากรณ์ Markdown ของ esa
  • 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: ภาษาสำหรับ 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": "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 - เอกสารอ้างอิง API ของ esa.io
  • Claude Desktop - ผู้ช่วย AI ที่รองรับ MCP

การสนับสนุน


สร้างด้วย ❤️ โดยทีม esa