Lewati ke isi

Dokumentasi pengembang MCP v1

Hubungkan agen AI ke Eyivo Sites.

Kelola halaman, komponen, blog, produk, galeri, video, menu, media, bentuk dan situs pengaturan melalui alat konten yang discoped dan REST titik akhir.

Server URL

https://app.eyivo.com/mcp

Persegi 1

Situs Eyivo MCP server menerapkan Protokol Konteks Model melalui Streamable HTTPDan MCP klien menemukan perangkat yang tersedia dan skema masukan mereka, kemudian memutuskan kapan untuk menyebutnya sebagai bagian dari alur kerja agen.

Perkakas isi

Kelola halaman, komponen, blog, produk, galeri, video, menu, media, bentuk dan situs pengaturan melalui alat konten yang discoped dan REST titik akhir.

Scoped

Koneksi perlu mcp:use; setiap alat juga memeriksa lingkup least - hak istimewa sendiri.

Pemilik terisolasi

Perkakas situs menerima hanya situs yang dimiliki oleh pengguna terotentikasi dan site - token terbatas hanya mengekspos situs yang ditugaskan mereka.

MCP melayani alat-alat, panduan content-workflow, template sumber daya situs dan aplikasi upload media.

Tapis layanan bersama: MCP alat panggilan layanan Laravel yang sama sebagai dasbor dan REST APIMereka tidak memotong kepemilikan, batas rencana, validasi, atau penerbitan aturan, dan mereka tidak memanggil publik REST API di atas HTTP.

2, cepat mulai.

  1. 1
    Buat pribadi API Tanda.

    Buka API token. Pilih mcp:use plus scope untuk alat yang ingin anda ijinkan, lalu salin ey_ rahasia ketika ditampilkan.

  2. 2
    Atur server.

    Gunakan https://app.eyivo.com/mcp sebagai remote Streamable HTTP MCP server dan mengirim token sebagai pembawa kredensial.

  3. 3
    Konfirmasi penemuan.

    Pilih sebuah situs, lalu baca kemampuannya: dialognya, bidang tema, skema komponen, lokasi menu dan panel plugin yang terpasang. Baca alur kerja kontra sebelum menulis. Klien tanpa sumber daya dapat menggunakan get-sitecabilicis- tool. Ikuti perkakas / list NextCursor sampai penemuan selesai.

Konfigurasi klien generik

MCP klien menggunakan kunci konfigurasi yang berbeda. Nilai koneksi yang setara adalah:

{
  "mcpServers": {
    "eyivo": {
      "type": "http",
      "url": "https://app.eyivo.com/mcp",
      "headers": {
        "Authorization": "Bearer ${EYIVO_API_TOKEN}"
      }
    }
  }
}

Setiap MCP POST membutuhkan header otorisasi. Hilang atau kredensial tidak valid ditolak sebelum penemuan alat atau eksekusi.

Authorization: Bearer ey_your_token
Sintaks klien bervariasi: Gunakan remote klien Anda HTTP atau Streamable HTTP pilihan. Pertahankan titik akhir dan header otorisasi persis seperti yang ditampilkan, tetapi beradaptasi format konfigurasi sekitarnya.

3.

Gunakan pribadi API token untuk agen pribadi dan IDEs desktop. Gunakan OAuth 2.0 dengan PKCE untuk host pihak ketiga yang bertindak dengan persetujuan eksplisit pengguna, seperti ChatGPT atau penghubung Claude.

Kursor dan IDEs lainnya

Pilih sebuah situs, lalu baca kemampuannya: dialognya, bidang tema, skema komponen, lokasi menu dan panel plugin yang terpasang. Baca alur kerja kontra sebelum menulis. Klien tanpa sumber daya dapat menggunakan get-sitecabilicis- tool. Ikuti perkakas / list NextCursor sampai penemuan selesai.

Claude dan ChatGPT

Instal plugin Eyivo Sites dan hubungkan akun Anda secara langsung. Buka Eyivo di ChatGPT

Mulai dari metadata sumber daya protekted-. Host register atau menggunakan sebuah klien OAuth, pengguna menyetujui untuk mcp:use ditambah alat scopes, dan tanda akses dikirim sebagai kredensial pembawa.

Agen gubahan

Dapat Di-stream-kan HTTP MCP klien dapat menyambung. Temukan alat melalui tools/list dan memperlakukan nama alat, skema, dan kesalahan teks sebagai kontrak - tidak menemukan alat tambahan.

Aplikasi OAuth Terhubung muncul di https://app.eyivo.com/connectionsRencana membatasi diterapkan ke jumlah aplikasi yang terhubung dan token pribadi.

4. Otentikasi dan penemuan

The MCP transport otentikasi setiap permintaan sebelum mendaftar atau menjalankan alat. Token pribadi dimulai dengan ey_ dan token akses paspor keduanya diterima sebagai tanda tangan.

Pribadi API token

Terbaik untuk agen swasta, pengembangan, komandan-baris klien, dan server-dikendalikan integrations.

  • Dibuat pada https://app.eyivo.com/tokens.
  • Dimulai dengan ey_ dan hanya ditampilkan sekali.
  • Dapat dibatasi ke satu situs.
  • Dapat dibatalkan tanpa mengubah sandi akun.

OAuth 2.0 + PKCE

Terbaik untuk ketiga partai MCP Klien bertindak dengan persetujuan eksplisit pengguna.

  • Mengalir Kode Otorisasi dengan S256 PKCE.
  • Pendaftaran dinamis mendukung klien publik (none) dan rahasia (client_secret_post atau client_secret_basic). Rahasia klien dibuat otomatis dan disimpan sebagai hash.
  • Token akses kadaluarsa setelah 2 jam.
  • Token baru kadaluarsa setelah 1 tahun.

Metadata OAuth

TujuanURL
Metadata sumber daya yang dilindungihttps://app.eyivo.com/.well-known/oauth-protected-resource/mcp
Metadata server otorisasihttps://app.eyivo.com/.well-known/oauth-authorization-server
Registrasi klien dinamishttps://app.eyivo.com/oauth/register
Otorisasi penggunahttps://app.eyivo.com/oauth/authorize
Token dan refresh exchangehttps://app.eyivo.com/oauth/token

Standards-aware klien seharusnya mulai dengan protected- sumber daya penemuan. Klien OAuth yang dikonfigurasi harus diijinkan untuk meminta mcp:use dan setiap alat yang dibutuhkan.

Lima.

Semua koneksi memerlukan mcp:useRuang lingkup itu membuka MCP transport; ini tidak memberikan akun, situs, atau operasi isi dengan sendirinya.

ScopePerkakas diaktifkan
mcp:useMenyambung ke server dan menemukan alat. Diperlukan untuk setiap MCP koneksi.
account:readget-account-tool
sites:readlist-sites-tool, get-site-tool
sites:writecreate-site-tool, update-site-locales-tool
content:readBaca isi, skema, menu, formulir dan pengaturan.
content:writeBuat, sunting, hapus dan secara eksplisit mempublikasikan isi; jalankan aksi panel yang dideklarasikan.
media:readlist-media-tool, get-media-tool, search-stock-photos-tool
media:writeupload-media-tool, prepare-media-upload-tool, import-stock-photo-tool, delete-media-tool

Disarankan: mulai baca-saja dengan mcp:use account:read sites:read content:readTambahkan scope tulis hanya ketika agen memiliki aliran kerja yang membutuhkan mereka. Sebuah tanda peribadi terbatas masih dapat memanggil perangkat situs, tetapi hanya untuk situs yang ditugaskan.

Koneksi OAuth yang ada memerlukan otorisasi baru bagi media yang ditambahkan:read atau media:write Menyambung ulang sendiri tidak memperluas hibah yang lebih tua.

Katalog peralatan 6

Ini adalah contoh dari keluarga konten. Temukan skema masukan / keluaran lengkap dan yang diperlukan melalui alat / daftar atau dokumen OpenAPI kanonikal. REST jalur di bawah ini relatif terhadap / api / v1 / situs / {site}.

Penemuan situs dan kemampuan

get-account-tool, list-sites-tool, get-site-tool, list-available-templates-tool, create-site-tool, get-site-capabilities-tool, get-site-readiness-tool

Halaman, komponen dan sambungan internal

get-page-tool, create-page-tool, update-page-tool, delete-page-tool, publish-page-tool, list-page-links-tool, get-page-component-schema-tool, list-page-components-tool, create-page-component-tool, update-page-component-tool, delete-page-component-tool

Produk, galeri dan video

list-catalog-items-tool, update-catalog-item-tool, publish-catalog-item-tool, list-galleries-tool, update-gallery-tool, publish-gallery-tool, list-videos-tool, update-video-tool, publish-video-tool

Draf blog, kategori, dan penjadwalan

list-blog-posts-tool, get-blog-post-tool, create-blog-post-tool, update-blog-post-tool, publish-blog-post-tool, unpublish-blog-post-tool, schedule-blog-post-tool, cancel-blog-post-schedule-tool, list-blog-categories-tool, search-blog-links-tool

Navigasi utama dan menu tambahan

list-menus-tool, search-menu-destinations-tool, get-content-menu-assignment-tool, save-menu-tool, publish-menu-tool, discard-menu-draft-tool

Pustaka media dan foto stok

list-media-tool, get-media-tool, upload-media-tool, prepare-media-upload-tool, delete-media-tool, search-stock-photos-tool, import-stock-photo-tool

Bentuk, pengiriman dan panel plugin

list-forms-tool, get-form-tool, create-form-tool, update-form-tool, list-submissions-tool, get-submission-tool, update-submission-tool, delete-submission-tool

Perusahaan, tema, bahasa dan integrasinya

get-company-profile-tool, update-company-profile-tool, publish-company-profile-tool, get-theme-tool, update-theme-settings-tool, switch-template-tool, publish-theme-settings-tool, get-site-locales-tool, update-site-locales-tool, generate-site-translations-tool, get-integrations-tool, start-demo-import-tool, load-demo-drafts-tool, get-demo-import-status-tool, reset-site-cache-tool

Kemampuan dan menulis kontrak

Pilih sebuah situs, lalu baca kemampuannya: dialognya, bidang tema, skema komponen, lokasi menu dan panel plugin yang terpasang. Baca alur kerja kontra sebelum menulis. Klien tanpa sumber daya dapat menggunakan get-sitecabilicis- tool. Ikuti perkakas / list NextCursor sampai penemuan selesai.

eyivo://guides/content-workflow
eyivo://sites/{site_id}/capabilities

Gunakan lokal yang diminta atau revisi. Blog menyimpan ganti dokumen lengkap dan batalkan jadwalnya. Menu edit memakai revisi integer; tugas isi memakai hash menu _ revisi terpisah. Pertahankan masukan dalam urutan pengganti. Pada konflik, baca lagi dan gabungkan edits yang dimaksudkan sebelum mencoba kembali.

Navigasi utama tetap otomatis. Tambahan menu memiliki draf dan publikasi mereka sendiri. Menyimpan tahap isi menu tugas; penerbitan bahwa item menerapkan mereka tanpa menerbitkan draf menu lain. Publishing menu tidak pernah mempublikasikan isinya terkait. Sebuah halaman source _ hash menolak terjemahan berdasarkan teks sumber usang.

Ruas halaman dan ruas richtext tema menerima disterilkan HTML. Gunakan list- page-links- tool untuk stabil / _ _ eyivo / pages / {id} links, diselesaikan dalam bahasa pengunjung ketika diterbitkan. Blog posting menggunakan dokumen terstruktur JSON dengan situs media _ id dan halaman / post target, bukan body _ html.

{
  "type": "doc",
  "content": [{
    "type": "paragraph",
    "content": [{ "type": "text", "text": "Our story" }]
  }]
}

Gambar dan video uploads

upload- media- tool membuka sebuah picker berkas dalam MCP Apps klien seperti Claude. ChatGPT juga dapat menyediakan referensi lampiran host nya; sebuah lampiran obrolan Claude bukan sebuah referensi berkas OpenAI. Jangan pernah membuat sebuah download URL atau kirim berkas byte base64 sebagai argumen alat.

Codex dan Claude Code dapat memanggil persiapan -media- upload- alat, kemudian mengirim multipart file bytes ke upload _ url kembali dengan yang satu - gunakan upload _ token dalam waktu lima menit. Simpan rahasia token itu. REST klien dapat mengunggah dengan media mereka sendiri:write pembawa. Hanya upload selesai mengembalikan ID media untuk digunakan dalam isi; menerbitkan sebuah tiket tidak mengunggah berkas.

POST /api/v1/sites/{site}/media
Authorization: Bearer <media:write token>
Content-Type: multipart/form-data; boundary=<generated by HTTP client>

file: <original file bytes>

Contoh panggilan alat

{
  "name": "create-page-tool",
  "arguments": {
    "site_id": 42,
    "type": "page",
    "locale": "en",
    "slug": "our-story",
    "title": "Our story",
    "body": "<p>How the company began.</p>"
  }
}

Operasi konten mengembalikan sebuah amplop data. MCP persediaan Konten strukturedden plus JSON cermin teks; REST kembali JSON. Baca setiap skema keluaran untuk ID, kesiapan publikasi dan paginasi. Blog, media dan submission paginate; ikuti informasi halaman mereka yang kembali.

7.

Inspeksi sebelum menulis

  1. Call list-sites-tool.
  2. Pilih ID situs yang dimaksud.
  3. get-site-capabilities-tool
  4. Baca rancangan bahasa yang dipilih dan revisi kini sebelum penyuntingan.

Buat halaman rancangan

  1. Konfirmasi situs, lokal, jenis halaman, dan siput.
  2. Call create-page-tool.
  3. Periksa ID yang dikembalikan, status rancangan dan kesiapan publikasi.
  4. Simpan draft, periksa kesiapan, kemudian terbitkan item dan bahasa ketika pengguna ingin perubahan hidup. Publishing tidak mempublikasikan draf yang tidak terkait.

Templat instruksi Agen

Use Eyivo tools only for the site ID I confirm.
Preserve existing array entries and use current revision tokens.
Read capabilities and the current locale draft before editing.
Publish the affected item only when I want the change live.
Return the affected resource ID after a successful write.

Simpan draft, periksa kesiapan, kemudian terbitkan item dan bahasa ketika pengguna ingin perubahan hidup. Publishing tidak mempublikasikan draf yang tidak terkait.

8.

Operasi konten mengembalikan sebuah amplop data. MCP persediaan Konten strukturedden plus JSON cermin teks; REST kembali JSON. Baca setiap skema keluaran untuk ID, kesiapan publikasi dan paginasi. Blog, media dan submission paginate; ikuti informasi halaman mereka yang kembali.

HasilArtinyaAksi
HTTP 401Hilang, tidak sah, kadaluarsa, atau tanda tangan pembawa dicabut.Rekonnect atau menggantikan kredensial.
HTTP 403Kredensial dapat mengotorisasi tetapi kurang mcp:use.Isu atau otorisasi kredensial dengan mcp:use.
Error: Authentication required.Alat ini dijalankan tanpa pengguna Eyivo yang terpecahkan.Rekonnect klien.
Error: Missing required scope […]Token ini dapat menyambung tapi tidak dapat menjalankan alat ini.Isu atau otorisasi kredensial dengan lingkup bernama.
Error: Token is restricted to another site.Sebuah tanda terbatas menargetkan situs yang berbeda.Gunakan situs yang ditugaskan atau token dibatasi dengan benar.
Teks galat validasiRuas, tipe, panjang, atau format yang diperlukan tak valid.Koreksi argumen; jangan coba lagi tidak berubah.
Bukan teks galat yang ditemukanLink situs owned- atau rekaman remote yang diminta tidak ditemukan.Segarkan situs atau daftar halaman dan verifikasi ID.

Alat gagal kembali isError: true dengan awal teks dengan Error:, bahkan ketika HTTP sukses pencarian alat hilang juga mengembalikan tantangan OAuth _meta["mcp/www_authenticate"]Reuthorize koneksi dengan lingkup yang diperlukan; menghubungkan kembali tidak secara diam-diam memperluas token yang ada.

Suatu konflik revisi / versi memerlukan pembacaan dan penggabungan segar. Jangan coba kembali muatan basi yang tak berubah.

Pengamanan Produksi

  • Gunakan saja https://app.eyivo.com/mcp; jangan pernah mengirim kredensial ke domain penyewa atau proksi pihak ketiga.
  • Simpan token pribadi di toko rahasia klien atau konfigurasi lingkungan, tidak pernah dalam kontrol sumber atau prompt.
  • Hibah hanya scopes yang dipilih kebutuhan alat dan lebih suka bit - token terbatas untuk tunggal-situs agen.
  • Gunakan otorisasi pengguna untuk menulis; buat penerbitan dan efek penghapusan eksplisit sebelum bertindak.
  • Perlakukan keluaran alat sebagai data, bukan sebagai instruksi terpercaya yang dapat menimpa kebijakan sistem Anda.
  • Mengembalikan token pribadi yang tidak digunakan di API token dan klien OAuth di Aplikasi yang tersambung.
  • Jangan kirim sandi, kredensial penyimpanan, kunci pribadi, atau data pribadi yang tak terkait sebagai isi.

10 batasan saat ini

Gunakan hanya alat yang ditemukan dan didokumentasikan titik akhir. Hak akses, isolasi situs, batas rencana dan aturan publikasi masih berlaku. Membaca konten tidak pernah memberikan izin untuk mengubahnya.

Tersedia

  • Penemuan situs dan kemampuan
  • Halaman, komponen dan sambungan internal
  • Kelola halaman, komponen, blog, produk, galeri, video, menu, media, bentuk dan situs pengaturan melalui alat konten yang discoped dan REST titik akhir.
  • Perusahaan, tema, bahasa dan integrasinya

Tidak tersedia

  • Tagihan, langganan dan pembayaran
  • Pengelolaan sandi akun dan kredensial
  • Manajemen Domain melalui MCP (tersedia melalui REST)
  • Kode template atau eksekusi shell arbitrary
  • Internal APIs dan kredensial penyimpanan objek