esa MCP Server

resmi

esa.io için resmi Model Context Protocol (MCP) sunucusu - STDIO taşıma sürümü.

GitHub
57

Dokümantasyon

esa MCP Sunucusu

License: MIT

日本語 | English

esa.io için resmi Model Context Protocol (MCP) sunucusu - STDIO aktarım sürümü.

Genel Bakış

Bu MCP sunucusu, yapay zeka asistanları ile ortak çalışmaya dayalı dokümantasyon platformu esa.io arasında sorunsuz entegrasyon sağlar. Yapay zeka asistanlarının, Model Context Protocol aracılığıyla doğrudan esa dokümanlarını okumasını, oluşturmasını, güncellemesini ve yönetmesini mümkün kılar.

Kullanılabilir Araçlar

Takım Yönetimi

  • esa_get_teams - Kullanıcının erişilebilir esa takımlarını getirir
  • esa_get_team_stats - Takım istatistiklerini getirir (üyeler, gönderiler, yorumlar, yıldızlar, izleyiciler, aktif kullanıcılar)
  • esa_get_team_tags - Takım gönderilerinde kullanılan tüm etiketleri sayılarıyla birlikte getirir
  • esa_get_team_members - Takım üyelerini rolleri ve profil bilgileriyle birlikte getirir

Gönderi Yönetimi

  • esa_search_posts - esa.io'da gönderi arar
  • esa_get_post - Gönderi numarasına göre belirli bir gönderiyi getirir (gövdenin karakter ve satır sayılarıyla birlikte backlinks_count ve body_md_stats içerir)
  • esa_get_post_backlinks - Belirli bir gönderiye referans veren gönderileri sayfalandırma ile listeler
  • esa_create_post - Etiketler, kategori ve WIP durumu ile yeni bir gönderi oluşturur
  • esa_update_post - Mevcut gönderiyi günceller (başlık, içerik, etiketler, kategori, WIP durumu)
  • esa_append_post - Gönderi gövdesinin sonuna içerik ekler (mevcut gövdeyi getirmeye gerek yoktur; yeni bir revizyon olarak kaydedilir)
  • esa_prepend_post - Gönderi gövdesinin başına içerik ekler (mevcut gövdeyi getirmeye gerek yoktur; yeni bir revizyon olarak kaydedilir)

Gönderi Eylemleri

  • esa_archive_post - Bir gönderiyi Arşivlenmiş/ kategorisine taşıyarak arşivler
  • esa_ship_post - Bir gönderiyi yayınlar (wip değerini false yaparak tamamlandı olarak işaretler)
  • esa_duplicate_post - Bir gönderiyi çoğaltır (aynı başlık ve gövdeye sahip yeni bir WIP gönderisi oluşturur; takımlar arası çoğaltma da desteklenir)

Yorum Yönetimi

  • esa_get_comment - ID'ye göre belirli bir yorumu getirir
  • esa_create_comment - Bir gönderiye yeni bir yorum oluşturur
  • esa_update_comment - Mevcut bir yorumu günceller
  • esa_delete_comment - Bir yorumu siler
  • esa_get_post_comments - Belirli bir gönderi için yorumları sayfalandırma ile getirir
  • esa_get_team_comments - Takım yorumlarını sayfalandırma ile getirir

Kategori Yönetimi

  • esa_get_categories - Belirli bir yol için kategorileri ve alt kategorileri getirir
  • esa_get_top_categories - Bir takım için tüm üst düzey kategorileri getirir
  • esa_get_all_category_paths - Bir takımdaki tüm kategori yollarını getirir (gönderi sayılarıyla birlikte, filtrelemeyi destekler)
    • Kategori yapısını anlamak, organizasyon planlaması ve temizlik için mükemmeldir
    • Filtre örnekleri: geliştirme ile ilgili için prefix: "dev", API ile ilgili kategoriler için match: "api"

Ekler

  • esa_get_attachment - esa gönderilerinden ve yorumlarından bir ek dosyası alır
    • 30MB altındaki desteklenen görseller (JPEG, PNG, GIF, WebP) için base64 kodlu veri döndürür
    • Diğer dosya türleri, daha büyük görseller veya forceSignedUrl belirtildiğinde imzalı URL'ler (5 dakika geçerli) döndürür

Yardım & Dokümantasyon

  • esa_get_search_options_help - esa arama sözdizimi dokümantasyonunu getirir
  • esa_get_markdown_syntax_help - esa Markdown sözdizimi dokümantasyonunu getirir
  • esa_search_help - Özellikler ve terminoloji için esa dokümantasyonunda arama yapar

Kullanılabilir Kaynaklar

  • esa_recent_posts - esa takımından son güncellenen gönderileri getirir
    • Şablon: esa://teams/{teamName}/posts/recent
    • Döndürür: Son güncellenen gönderilerin JSON listesi

Kullanılabilir İstemler

  • esa_summarize_post - Bir esa gönderi içeriğini özetler
    • Girdi: Takım adı ve gönderi numarası
    • Çıktı: Gönderi içeriğinin yapılandırılmış özeti

MCP İstemci Yapılandırması

MCP istemci yapılandırma dosyanıza ekleyin:

Gerekli Ortam Değişkenleri

  • ESA_ACCESS_TOKEN: Erişim Anahtarı
    • Gerekli kapsamlar: read write veya admin:comment read:post write:post read:category read:tag read:attachment read:team read:member
    • PAT v2 önerilir.
  • LANG: Kullanıcı arayüzü için dil

Claude Desktop Örneği

claude_desktop_config.json dosyasına ekleyin:

Seçenek 1: Docker (Önerilir)

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

Seçenek 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"
      }
    }
  }
}

Not: /path/to/your/node kısmını which node komutunun çıktısı ile değiştirin.

Kayıt

Bu paket, kayıtlı araçları, kaynakları ve istemleri açığa çıkaran registry.json dosyasını paket kökünde sunar. Sunucuyu başlatmadan programatik olarak tüketilebilir:

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

Şema:

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

Dosya npm run build:registry tarafından yeniden oluşturulur ve bir CI kontrolü, kayıtlı set ile senkronize kalmasını zorunlu kılar.

Bağlantılar

Destek

esa ekibi tarafından ❤️ ile yapıldı