esa MCP Server

resmi

Server Protokol Konteks Model (MCP) resmi untuk esa.io - versi transport STDIO.

Apa yang bisa Anda lakukan dengan Esa MCP?

  • Cari dan baca postingan — Temukan postingan dengan esa_search_posts, lalu ambil postingan tertentu berdasarkan nomornya dengan esa_get_post untuk melihat jumlah backlink dan statistik isi postingan.
  • Buat dan edit konten — Buat postingan dengan esa_create_post, perbarui dengan esa_update_post, atau tambahkan teks di akhir maupun awal menggunakan esa_append_post dan esa_prepend_post.
  • Kelola siklus hidup postingan — Terbitkan postingan dengan esa_ship_post, arsipkan dengan esa_archive_post, duplikasikan dengan esa_duplicate_post, atau kembalikan ke revisi sebelumnya.
  • Kelola komentar — Tampilkan daftar komentar pada postingan atau tim, lalu buat, perbarui, atau hapus komentar dengan esa_create_comment, esa_update_comment, dan esa_delete_comment.
  • Jelajahi kategori dan tim — Telusuri jalur kategori dengan esa_get_all_category_paths dan periksa detail tim dengan esa_get_team_stats dan esa_get_team_members.
  • Ringkas postingan — Gunakan prompt esa_summarize_post untuk mendapatkan ringkasan terstruktur dari postingan tim tertentu.

Dokumentasi

esa MCP Server

License: MIT

日本語 | English

Server Model Context Protocol (MCP) resmi untuk esa.io - versi transport STDIO.

Ikhtisar

Server MCP ini menyediakan integrasi yang lancar antara asisten AI dan esa.io, platform dokumentasi kolaboratif. Server ini memungkinkan asisten AI membaca, membuat, memperbarui, dan mengelola dokumen esa secara langsung melalui Model Context Protocol.

Alat yang Tersedia

Manajemen Tim

  • esa_get_teams - Mendapatkan tim esa yang dapat diakses pengguna
  • esa_get_team_stats - Mendapatkan statistik tim (anggota, postingan, komentar, bintang, pantauan, pengguna aktif)
  • esa_get_team_tags - Mendapatkan semua tag yang digunakan dalam postingan tim beserta jumlahnya
  • esa_get_team_members - Mendapatkan anggota tim beserta peran dan informasi profil

Manajemen Postingan

  • esa_search_posts - Mencari postingan di esa.io
  • esa_get_post - Mendapatkan postingan tertentu berdasarkan nomor postingan (termasuk backlinks_count dan body_md_stats yang berisi jumlah karakter dan baris pada isi)
  • esa_get_post_backlinks - Mencantumkan postingan yang merujuk ke postingan tertentu dengan paginasi
  • esa_create_post - Membuat postingan baru dengan tag, kategori, dan status WIP
  • esa_update_post - Memperbarui postingan yang sudah ada (judul, konten, tag, kategori, status WIP)
  • esa_append_post - Menambahkan konten di akhir isi postingan (tidak perlu mengambil isi saat ini; disimpan sebagai revisi baru)
  • esa_prepend_post - Menambahkan konten di awal isi postingan (tidak perlu mengambil isi saat ini; disimpan sebagai revisi baru)

Tindakan Postingan

  • esa_archive_post - Mengarsipkan postingan dengan memindahkannya ke kategori Archived/
  • esa_ship_post - Menyelesaikan postingan (menandainya sebagai selesai dengan mengatur wip ke false)
  • esa_duplicate_post - Menduplikasi postingan (membuat postingan WIP baru dengan judul dan isi yang sama; duplikasi lintas tim juga didukung)
  • esa_rollback_post_revision - Mengembalikan postingan ke revisi yang ditentukan (konten yang dipulihkan disimpan sebagai revisi baru; periksa nomor revisi melalui revision_number di esa_get_post)

Manajemen Komentar

  • esa_get_comment - Mendapatkan komentar tertentu berdasarkan ID
  • esa_create_comment - Membuat komentar baru pada postingan
  • esa_update_comment - Memperbarui komentar yang sudah ada
  • esa_delete_comment - Menghapus komentar
  • esa_get_post_comments - Mendapatkan komentar untuk postingan tertentu dengan paginasi
  • esa_get_team_comments - Mendapatkan komentar tim dengan paginasi

Manajemen Kategori

  • esa_get_categories - Mendapatkan kategori dan subkategori untuk jalur tertentu
  • esa_get_top_categories - Mendapatkan semua kategori tingkat teratas untuk sebuah tim
  • esa_get_all_category_paths - Mendapatkan semua jalur kategori dalam tim (dengan jumlah postingan, mendukung pemfilteran)
    • Cocok untuk memahami struktur kategori, merencanakan pengorganisasian, dan melakukan pembersihan
    • Contoh filter: prefix: "dev" untuk kategori terkait pengembangan, match: "api" untuk kategori terkait API

Lampiran

  • esa_get_attachment - Mengambil file lampiran dari postingan dan komentar esa
    • Mengembalikan data yang dikodekan dalam base64 untuk gambar yang didukung (JPEG, PNG, GIF, WebP) berukuran di bawah 30MB
    • Mengembalikan URL bertanda tangan (berlaku selama 5 menit) untuk jenis file lain, gambar yang lebih besar, atau saat forceSignedUrl ditentukan

Bantuan & Dokumentasi

  • esa_get_search_options_help - Mendapatkan dokumentasi sintaks pencarian esa
  • esa_get_markdown_syntax_help - Mendapatkan dokumentasi sintaks Markdown esa
  • esa_search_help - Mencari dokumentasi esa untuk fitur dan istilah

Resource yang Tersedia

  • esa_recent_posts - Mengambil postingan yang baru diperbarui dari tim esa
    • Templat: esa://teams/{teamName}/posts/recent
    • Mengembalikan: daftar JSON berisi postingan yang baru diperbarui

Prompt yang Tersedia

  • esa_summarize_post - Merangkum konten postingan esa
    • Input: Nama tim dan nomor postingan
    • Output: Ringkasan terstruktur dari konten postingan

Konfigurasi Klien MCP

Tambahkan ke file konfigurasi klien MCP Anda:

Variabel Lingkungan yang Diperlukan

  • ESA_ACCESS_TOKEN: Token akses
    • Cakupan yang diperlukan: read write atau admin:comment read:post write:post read:category read:tag read:attachment read:team read:member
    • PAT v2 direkomendasikan.
  • LANG: Bahasa untuk UI

Contoh Claude Desktop

Tambahkan ke claude_desktop_config.json:

Opsi 1: Docker (Direkomendasikan)

{
  "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"
      }
    }
  }
}

Opsi 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"
      }
    }
  }
}

Catatan: Ganti /path/to/your/node dengan output dari perintah which node.

Registry

Paket ini menyertakan registry.json di root paket, yang mengekspos alat, resource, dan prompt terdaftar. Registry ini dapat digunakan secara terprogram tanpa menjalankan server:

import registry from "@esaio/esa-mcp-server/registry.json" with {
  type: "json",
};

Skema:

{
  "tools": [{ "name": "esa_get_teams" }, "..."],
  "resources": [
    {
      "name": "esa_recent_posts",
      "uriTemplate": "esa://teams/{teamName}/posts/recent"
    }
  ],
  "prompts": [{ "name": "esa_summarize_post" }]
}

File ini dibuat ulang oleh npm run build:registry, dan pemeriksaan CI memastikan file tersebut tetap sinkron dengan kumpulan yang terdaftar.

Tautan

Dukungan


Dibuat dengan ❤️ oleh tim esa