Dokumentasi pengembang
Instal SosoAPI: paket, klien, dan MCP jarak jauh
Hubungkan agen Anda ke SosoAPI menggunakan paket lokal atau MCP hosted. Panduan ini mencakup instalasi, pemeriksaan koneksi, dan pembaruan.
Baca sebagai MarkdownDitinjau tim SosoAPI ·
Paket npm mana yang harus saya instal?
Instal sosoapi untuk pengaturan baru. Paket @sosoapi/cli, sosoapi-cli, dan sosoapi-mcp adalah alias yang menginstal versi sosoapi persis sama. Semuanya menjalankan CLI dan alat MCP sama, jadi Anda hanya perlu satu paket.
MCP lokal memerlukan Node.js 20 atau lebih baru dan npm/npx. MCP hosted tidak memerlukan paket lokal. Setelah instalasi atau koneksi, masuk untuk memberikan akses ke akun Anda.
| Paket | Tujuan | Command |
|---|---|---|
| sosoapi | CLI dan server MCP kanonis | npx -y sosoapi --help |
| @sosoapi/cli | Alias sosoapi dengan versi persis | npx -y @sosoapi/cli --help |
| sosoapi-cli | Alias sosoapi dengan versi persis | npx -y sosoapi-cli --help |
| sosoapi-mcp | Alias sosoapi dengan versi persis | npx -y sosoapi-mcp --help |
Hubungkan klien MCP lokal
Gunakan command di bawah untuk menambahkan koneksi profil core. Jika SosoAPI sudah terhubung dan berfungsi, pertahankan koneksi tersebut. Menjalankan sosoapi tanpa argumen memulai server MCP stdio; server menunggu klien pada stdin.
Untuk Claude Desktop, Cursor, atau klien stdio lain, tambahkan JSON di bawah ke pengaturan MCP-nya. Lokasi pengaturan dan langkah persetujuan berbeda menurut klien. Mulai atau hubungkan ulang klien jika perlu, lalu periksa alat SosoAPI tersedia dalam percakapan.
claude mcp add sosoapi -e SOSOAPI_TOOL_PROFILE=core -- npx -y sosoapicodex mcp add sosoapi --env SOSOAPI_TOOL_PROFILE=core -- npx -y sosoapi{
"mcpServers": {
"sosoapi": {
"command": "npx",
"args": [
"-y",
"sosoapi"
],
"env": {
"SOSOAPI_TOOL_PROFILE": "core"
}
}
}
}Hubungkan MCP jarak jauh dengan OAuth
Di klien yang mendukung MCP jarak jauh, OAuth, dan pendaftaran klien dinamis, tambahkan URL di bawah. Masuk melalui browser dan pilih ruang kerja serta tindakan yang ingin diizinkan. Anda tidak perlu menempelkan kunci API, client ID, atau client secret. Untuk menyediakan media melalui HTTP, impor URL publik; unggahan file lokal memerlukan server MCP lokal.
Aplikasi kustom ChatGPT dan konektor jarak jauh Claude bergantung pada paket serta pengaturan konektor yang tersedia di klien. Instruksi ini menyiapkan koneksi kustom; tidak menjelaskan listing direktori aplikasi.
https://gqeshlawtcexsapabaui.supabase.co/functions/v1/remote-mcpVerifikasi pengaturan tanpa publikasi
Periksa status autentikasi dan masuk jika diperlukan. Baca konteks ruang kerja dan akun terhubung, lalu konfirmasikan bahwa akun dan ruang kerja yang dikembalikan sesuai maksud Anda. Ini memverifikasi akses tanpa mengirim postingan; publikasi tetap bergantung pada izin akun tersebut.
Anda tidak perlu memublikasikan postingan uji untuk menyelesaikan pengaturan. Lanjutkan tugas awal dengan konten yang ada. Pengguna menyelesaikan persetujuan penyedia serta meninjau tujuan, konten, dan waktu sebelum penulisan yang diminta.
npx sosoapi auth statusnpx sosoapi api contract --route /identity-api/workspace/list --summaryPerbarui atau kunci versi
Jalankan npx -y sosoapi@latest --help untuk mengambil CLI terkini, lalu mulai ulang klien MCP Anda. Jika klien menyimpan command, letakkan versi yang Anda inginkan dalam args-nya. Alias tetap terikat pada versi sosoapi persisnya; memperbarui instalasi global terpisah tidak akan memperbaruinya.
Jika Anda melihat kesalahan perbedaan versi, bandingkan kontrak terpasang dengan operasi yang diperlukan. Perbarui paket dalam command yang benar-benar digunakan klien MCP, hubungkan ulang, dan coba operasi tersebut lagi. Ketidakcocokan skema tidak memerlukan kredensial baru atau akses lebih luas.
npx -y sosoapi@latest --helpnpx sosoapi api contract --summary