Utviklerdokumentasjon
Installer SosoAPI: pakker, klienter og ekstern MCP
Koble agenten din til SosoAPI med en lokal pakke eller vertet MCP. Denne veiledningen dekker installasjon, tilkoblingskontroller og oppdateringer.
Les som MarkdownGjennomgått av SosoAPI-teamet ·
Hvilken npm-pakke bør jeg installere?
Installer sosoapi for et nytt oppsett. Pakkene @sosoapi/cli, sosoapi-cli og sosoapi-mcp er aliaser som installerer nøyaktig samme versjon av sosoapi. De kjører samme CLI- og MCP-verktøy, så du trenger bare én pakke.
Lokal MCP krever Node.js 20 eller nyere og npm/npx. Vertet MCP trenger ingen lokal pakke. Logg inn etter installasjon eller tilkobling for å gi tilgang til kontoene dine.
| Pakke | Formål | Kommando |
|---|---|---|
| sosoapi | Kanonisk CLI og MCP-server | npx -y sosoapi --help |
| @sosoapi/cli | Alias for en nøyaktig versjon av sosoapi | npx -y @sosoapi/cli --help |
| sosoapi-cli | Alias for en nøyaktig versjon av sosoapi | npx -y sosoapi-cli --help |
| sosoapi-mcp | Alias for en nøyaktig versjon av sosoapi | npx -y sosoapi-mcp --help |
Koble til en lokal MCP-klient
Bruk kommandoene nedenfor til å legge til en core-profiltilkobling. Hvis SosoAPI allerede er tilkoblet og fungerer, behold tilkoblingen. Kjøring av sosoapi uten argumenter starter stdio MCP-serveren; den venter på klienten via stdin.
For Claude Desktop, Cursor eller en annen stdio-klient, legg til JSON-en nedenfor i MCP-innstillingene. Plassering av innstillinger og godkjenningstrinn varierer etter klient. Start på nytt eller koble til igjen ved behov, og kontroller at SosoAPI-verktøy er tilgjengelige i samtalen.
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"
}
}
}
}Koble til ekstern MCP med OAuth
Legg til URL-en nedenfor i en klient som støtter ekstern MCP, OAuth og dynamisk klientregistrering. Logg inn gjennom nettleseren og velg arbeidsområdene og handlingene du vil tillate. Du trenger ikke lime inn API-nøkkel, klient-ID eller klienthemmelighet. For å levere medier over HTTP, importer en offentlig URL; lokal filopplasting krever den lokale MCP-serveren.
Egendefinerte ChatGPT-apper og eksterne Claude-koblinger avhenger av abonnementet og koblingsinnstillingene som er tilgjengelige i klienten. Disse instruksjonene setter opp en egendefinert tilkobling; de beskriver ikke en oppføring i appkatalogen.
https://gqeshlawtcexsapabaui.supabase.co/functions/v1/remote-mcpVerifiser oppsett uten publisering
Kontroller autentiseringsstatus og logg inn om nødvendig. Les arbeidsområdekontekst og tilkoblede kontoer, og bekreft at den returnerte kontoen og arbeidsområdet er de du ønsket. Dette verifiserer tilgang uten å sende inn et innlegg; publisering avhenger fortsatt av kontoens tillatelser.
Du trenger ikke publisere et testinnlegg for å fullføre oppsettet. Fortsett den opprinnelige oppgaven med innholdet du allerede har. Brukeren fullfører leverandørsamtykket og gjennomgår mål, innhold og tidspunkt før en eventuell skriveoperasjon.
npx sosoapi auth statusnpx sosoapi api contract --route /identity-api/workspace/list --summaryOppdater eller fest en versjon
Kjør npx -y sosoapi@latest --help for å hente gjeldende CLI, og start MCP-klienten på nytt. Hvis klienten har en lagret kommando, sett ønsket versjon i args. Aliaser forblir knyttet til sin nøyaktige sosoapi-versjon; oppdatering av en separat global installasjon oppdaterer dem ikke.
Hvis du ser en versjonsavviksfeil, sammenlign den installerte kontrakten med operasjonen du trenger. Oppdater pakken i kommandoen MCP-klienten faktisk bruker, koble til igjen og prøv operasjonen på nytt. Et skjemaavvik krever ikke nye påloggingsopplysninger eller bredere tilgang.
npx -y sosoapi@latest --helpnpx sosoapi api contract --summary