Langsung ke konten utama

Ikhtisar

Nudgen menyediakan server MCP di /mcp pada origin aplikasi Anda. Server mendukung MCP 2026-07-28 melalui Streamable HTTP dan memerlukan OAuth 2.1. Masuk melalui browser dan setujui izin yang diminta. Jika tersedia, pilih satu ruang kerja atau izinkan secara eksplisit semua ruang kerja saat ini dan mendatang yang Anda ikuti. Beralih ruang kerja di dasbor tidak mengubah default MCP.

Bekerja di beberapa ruang kerja

Koneksi yang sudah ada tetap terbatas pada ruang kerja awal sampai Anda menghubungkan ulang dan menyetujui akses yang lebih luas. Dengan akses semua ruang kerja, keanggotaan baru tersedia otomatis. Kehilangan keanggotaan memblokir tindakan berikutnya di ruang kerja tersebut. Peran, langganan, dan kuota tetap berlaku per ruang kerja. Gunakan list_workspaces dengan page dan pageSize untuk melihat ID, nama, slug, peran, dan ruang kerja default. Cakupan teams:read diperlukan. Tambahkan workspaceId ke pemanggilan alat untuk memilih ruang kerja hanya bagi tindakan itu. Jika dihilangkan, default koneksi digunakan. Saat meninjau dan mengirim kampanye, berikan ID ruang kerja eksplisit yang sama. Pilih default saat persetujuan OAuth. Ubah melalui Pengaturan → Kunci API → Aplikasi MCP terhubung atau panggil set_default_workspace dengan workspaceId dan cakupan teams:write. Perubahan berlaku untuk semua chat yang memakai koneksi itu. Pilihan per panggilan tidak mengubah default. Jika default dihapus atau tidak dapat diakses, berikan ID lain atau perbarui default. Nudgen tidak diam-diam memilih pengganti.
URI sumber daya yang sudah ada memakai ruang kerja default. Template berikut menargetkan ruang kerja secara eksplisit:

Mengapa hal ini penting

Asisten dapat memeriksa kontak, mencari bisnis, dan membuat draf kampanye. Izinkan pengiriman atau penjadwalan di chat. Asisten langsung menjalankan tindakan tanpa tautan persetujuan browser.

Hubungkan klien Anda

Endpoint produksi adalah:
Tambahkan endpoint tersebut sebagai server MCP HTTP jarak jauh di klien yang mendukung OAuth. Klien akan menemukan server otorisasi Nudgen dari endpoint tersebut, lalu membuka alur masuk dan persetujuan di browser. Pilih ruang kerja yang ingin diakses klien dan setujui hanya cakupan yang diperlukan. Dokumen discovery: Server otorisasi menggunakan authorization code dengan PKCE S256, resource binding, dan rotasi refresh token. Server ini menerima Client ID Metadata Documents dan pendaftaran klien dinamis. Untuk Codex CLI, gunakan:
Jika klien bernama nudgen sudah dikonfigurasi, perbarui entri tersebut dengan URL /mcp. Gunakan campaigns:read untuk membaca, campaigns:write untuk draf dan perubahan, serta campaigns:send untuk tindakan email yang Anda izinkan. Persetujuan OAuth tetap diperlukan.
Personal Access Token mengautentikasi API Pengembang, tetapi tidak mengautentikasi /mcp. Klien MCP harus menyelesaikan proses masuk OAuth.

Alat yang tersedia

create_campaign menyimpan draf kampanye (one-time, drip, atau lifetime). Alat ini tidak dapat langsung mengirim atau menjadwalkan kampanye. get_campaign memungkinkan Anda memeriksa subjek, konten, tautan, audiens, dan pengirim sebelum peluncuran. Server juga menyediakan sumber daya hanya-baca melalui campaigns:read:

Temukan dan impor prospek dari peta

  1. Minta asisten memanggil search_map_leads dengan lokasi dan kata kunci bisnis, seperti kota dan marketing agency.
  2. Filter opsionalnya adalah radiusKm (1–100), lat dan lng, serta emailOnly untuk mempertahankan bisnis yang mencantumkan email.
  3. Jika hasil menyertakan nextPageToken, teruskan nilainya sebagai pageToken untuk memuat halaman berikutnya.
  4. Minta asisten memanggil import_map_leads dengan lokasi dan kata kunci yang sama, beserta objek prospek yang akan disimpan. Setiap panggilan menerima hingga 200 prospek.
Proses impor menulis kontak ke ruang kerja yang terhubung. Prospek tanpa email akan dilewati. Prospek yang sudah ada akan diperbarui.

Luncurkan draf kampanye

  1. Tinjau nama kampanye, subjek, isi, pengirim efektif, perkiraan penerima, dan waktu melalui get_campaign.
  2. Izinkan tindakan di chat. Asisten langsung memanggil launch_campaign dengan ID kampanye dan sendNow: true untuk mengirim sekarang atau scheduledAt dengan waktu mendatang beserta zona waktu. Jangan gabungkan waktu yang bertentangan. Izin yang sudah diberikan tidak perlu dikonfirmasi lagi.
  3. Periksa status, waktu terjadwal, dan tautan dashboard yang dikembalikan. Masuk antrean atau terjadwal belum berarti terkirim. Periksa get_campaign dan get_campaign_stats sebelum mengulang hasil yang belum pasti.
Nudgen tetap memeriksa izin workspace, kesiapan pengirim, penerima yang memenuhi syarat, langganan, kuota, versi kampanye, dan antrean. Pembuatan serta pengeditan hanya menyimpan draf; pengiriman memerlukan worker kampanye.

Kelola akses

Buka Pengaturan → Kunci API → Aplikasi MCP terhubung untuk memeriksa akses, mengubah default, atau memutuskan koneksi. Memutuskan koneksi beberapa ruang kerja mencabut token dan kode otorisasi tertundanya di semua ruang kerja tanpa memutus koneksi REST terpisah. OAuth REST dan asisten dalam aplikasi mempertahankan batas ruang kerja yang ada.

Pemecahan masalah

Untuk skrip yang menggunakan bearer token dan endpoint REST langsung, lihat API Pengembang.

Radius pencarian dan pengayaan

API dan MCP memakai 5 km secara default dan menerima bilangan bulat radiusKm 1–100 tanpa dialog konfirmasi dasbor. Pertahankan parameter saat mengirim nextPageToken sebagai pageToken. Halaman kosong masih dapat memiliki halaman berikutnya. enrichmentPending menandai riset situs yang belum selesai. Tinjau businessSummary dan businessSources jika tersedia. Konteks bisnis yang diimpor dapat membantu pembuka kampanye yang dipersonalisasi. Email yang belum ada mungkin masih diteliti. Jika ada enrichmentRetryToken, panggil retry_map_leads_enrichment dengan token dan campaigns:read. Token terikat ke ruang kerja tersambung, berlaku 15 menit, dan hanya sekali pakai. Gabungkan hasil berdasarkan placeId sebelum impor. emailOnly menyaring respons saat ini; lead dapat muncul setelah percobaan ulang.

Mengedit draf dan cakupan produk

Gunakan update_campaign untuk mengedit draf yang ada dan delete_campaign untuk menghapus draf. Keduanya memerlukan campaigns:write; keduanya tidak mengirim atau menjadwalkan email. Area produk baru memerlukan izin OAuth tersendiri. Hubungkan kembali dan setujui izin tersebut saat diminta. Daftar alat menunjukkan alat dan argumen yang tersedia. Pengalihan ke browser tidak menjalankan tindakan. Gunakan browser untuk pembayaran, otorisasi penyedia, undangan, membuat/menghapus/bergabung ke ruang kerja, dan pengaturan pencairan sensitif. Target dan default MCP tidak mengubah ruang kerja dasbor. Administrasi, kredensial, webhook, callback pelacakan, dan asisten internal tidak disertakan. Gunakan get_api_capabilities untuk memeriksa cakupan API. Setelah izin di chat, panggil langsung send_test_email, activate_lifetime_campaign, atau trigger_lifetime_campaign. Pengujian hanya dikirim ke email akun. Aktivasi lifetime mengizinkan pengiriman otomatis berikutnya. Tidak diperlukan persetujuan browser atau ID persetujuan. Periksa status atau riwayat eksekusi sebelum mengulang hasil yang belum pasti.