Documentation développeur
Installer SosoAPI : packages, clients et MCP distant
Connectez votre agent à SosoAPI via un package local ou MCP hébergé. Ce guide couvre l’installation, les vérifications de connexion et les mises à jour.
Lire en MarkdownVérifié par l’équipe SosoAPI ·
Quel package npm installer ?
Installez sosoapi pour une nouvelle configuration. Les packages @sosoapi/cli, sosoapi-cli et sosoapi-mcp sont des alias qui installent exactement la même version de sosoapi. Ils exécutent les mêmes outils CLI et MCP ; un seul package suffit.
MCP local nécessite Node.js 20 ou ultérieur et npm/npx. MCP hébergé ne nécessite aucun package local. Après installation ou connexion, identifiez-vous pour accorder l’accès à vos comptes.
| Package | Usage | Commande |
|---|---|---|
| sosoapi | CLI et serveur MCP canoniques | npx -y sosoapi --help |
| @sosoapi/cli | Alias de sosoapi à version identique | npx -y @sosoapi/cli --help |
| sosoapi-cli | Alias de sosoapi à version identique | npx -y sosoapi-cli --help |
| sosoapi-mcp | Alias de sosoapi à version identique | npx -y sosoapi-mcp --help |
Connecter un client MCP local
Utilisez les commandes ci-dessous pour ajouter une connexion au profil core. Si SosoAPI est déjà connecté et fonctionne, conservez cette connexion. Exécuter sosoapi sans arguments démarre le serveur MCP stdio ; il attend le client sur stdin.
Pour Claude Desktop, Cursor ou un autre client stdio, ajoutez le JSON ci-dessous à ses paramètres MCP. L’emplacement et les étapes d’approbation varient selon le client. Redémarrez ou reconnectez-le si nécessaire, puis vérifiez que les outils SosoAPI sont disponibles dans votre conversation.
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"
}
}
}
}Connecter MCP distant avec OAuth
Dans un client compatible avec MCP distant, OAuth et l’enregistrement dynamique, ajoutez l’URL ci-dessous. Identifiez-vous dans le navigateur et choisissez les espaces et actions autorisés. Aucun collage de clé API, client ID ou client secret n’est nécessaire. Pour fournir des médias sur HTTP, importez une URL publique ; le téléversement local nécessite le serveur MCP local.
Les applications personnalisées ChatGPT et les connecteurs distants Claude dépendent de votre forfait et des paramètres de connecteur disponibles. Ces instructions configurent une connexion personnalisée ; elles ne décrivent pas une inscription dans un annuaire d’applications.
https://gqeshlawtcexsapabaui.supabase.co/functions/v1/remote-mcpVérifier la configuration sans publier
Vérifiez auth status et identifiez-vous si nécessaire. Lisez le contexte et les comptes connectés, puis confirmez que le compte et l’espace renvoyés sont ceux souhaités. Cela vérifie l’accès sans envoyer de publication ; la publication dépend toujours des autorisations du compte.
Il n’est pas nécessaire de publier un test pour terminer la configuration. Reprenez votre tâche d’origine avec son contenu existant. L’utilisateur effectue le consentement fournisseur et valide la destination, le contenu et l’heure avant toute écriture demandée.
npx sosoapi auth statusnpx sosoapi api contract --route /identity-api/workspace/list --summaryMettre à jour ou fixer une version
Exécutez npx -y sosoapi@latest --help pour obtenir la CLI actuelle, puis redémarrez votre client MCP. Si le client a une commande enregistrée, indiquez la version souhaitée dans ses args. Les alias restent liés à leur version exacte de sosoapi ; mettre à jour une installation globale distincte ne les met pas à jour.
En cas d’erreur de décalage de version, comparez le contrat installé à l’opération souhaitée. Mettez à jour le package dans la commande réellement utilisée par votre client MCP, reconnectez-le et réessayez l’opération. Une incompatibilité de schéma ne nécessite ni nouveaux identifiants ni accès élargi.
npx -y sosoapi@latest --helpnpx sosoapi api contract --summary