Documentação para desenvolvedores
Instale o SosoAPI: pacotes, clientes e MCP remoto
Conecte seu agente ao SosoAPI usando um pacote local ou MCP hospedado. Este guia abrange instalação, verificações de conexão e atualizações.
Ler como MarkdownRevisado pela equipe SosoAPI ·
Qual pacote npm devo instalar?
Instale sosoapi para uma nova configuração. Os pacotes @sosoapi/cli, sosoapi-cli e sosoapi-mcp são aliases que instalam a mesma versão exata do sosoapi. Eles executam as mesmas ferramentas CLI e MCP, então você só precisa de um pacote.
MCP local exige Node.js 20 ou posterior e npm/npx. MCP hospedado não precisa de pacote local. Após instalar ou conectar, faça login para conceder acesso às suas contas.
| Pacote | Finalidade | Comando |
|---|---|---|
| sosoapi | CLI e servidor MCP canônicos | npx -y sosoapi --help |
| @sosoapi/cli | Alias de versão exata do sosoapi | npx -y @sosoapi/cli --help |
| sosoapi-cli | Alias de versão exata do sosoapi | npx -y sosoapi-cli --help |
| sosoapi-mcp | Alias de versão exata do sosoapi | npx -y sosoapi-mcp --help |
Conecte um cliente MCP local
Use os comandos abaixo para adicionar uma conexão com perfil core. Se o SosoAPI já estiver conectado e funcionando, mantenha essa conexão. Executar sosoapi sem argumentos inicia o servidor MCP stdio; ele aguarda o cliente em stdin.
Para Claude Desktop, Cursor ou outro cliente stdio, adicione o JSON abaixo nas configurações MCP. O local das configurações e as etapas de aprovação variam por cliente. Reinicie ou reconecte o cliente se necessário e confira se as ferramentas do SosoAPI estão disponíveis na conversa.
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"
}
}
}
}Conecte MCP remoto com OAuth
Em um cliente compatível com MCP remoto, OAuth e registro dinâmico de clientes, adicione a URL abaixo. Faça login pelo navegador e escolha os workspaces e ações que deseja permitir. Você não precisa colar API key, client ID ou client secret. Para fornecer mídia por HTTP, importe uma URL pública; o envio de arquivos locais exige o servidor MCP local.
Apps personalizados do ChatGPT e conectores remotos do Claude dependem do seu plano e das configurações de conectores disponíveis nesse cliente. Estas instruções configuram uma conexão personalizada; não descrevem uma listagem no diretório de apps.
https://gqeshlawtcexsapabaui.supabase.co/functions/v1/remote-mcpVerifique a configuração sem publicar
Confira o status de autenticação e faça login se necessário. Consulte o contexto do workspace e as contas conectadas e confirme se a conta e o workspace retornados são os desejados. Isso verifica o acesso sem enviar um post; a publicação ainda depende das permissões dessa conta.
Não é necessário publicar um post de teste para concluir a configuração. Continue sua tarefa original com o conteúdo existente. O usuário conclui o consentimento do provedor e revisa destino, conteúdo e horário antes de qualquer gravação solicitada.
npx sosoapi auth statusnpx sosoapi api contract --route /identity-api/workspace/list --summaryAtualize ou fixe uma versão
Execute npx -y sosoapi@latest --help para obter a CLI atual e reinicie seu cliente MCP. Se o cliente tiver um comando salvo, coloque a versão desejada em args. Os aliases continuam vinculados à versão exata do sosoapi; atualizar outra instalação global não os atualiza.
Se ocorrer um erro de divergência de versões, compare o contrato instalado com a operação necessária. Atualize o pacote no comando realmente usado pelo cliente MCP, reconecte e tente a operação novamente. Uma incompatibilidade de schema não exige novas credenciais nem acesso mais amplo.
npx -y sosoapi@latest --helpnpx sosoapi api contract --summary