MCP da Raims | Documentação da Raims

Conecte um aplicativo de IA à sua conta com acesso aos ambientes permitidos e às operações autorizadas.

O MCP da Raims permite que um aplicativo de IA consulte dados e solicite operações na conta que você autorizar. Uma conexão reúne os ambientes permitidos da empresa e os acessos definidos no consentimento.

https://mcp.raims.com

A autenticação no aplicativo de IA e a autenticação na Raims são separadas. O aplicativo não precisa receber sua senha da Raims nem uma chave da Public API. As permissões atuais de quem autorizou a conexão continuam limitando o acesso.

O MCP usa a autorização geral de Aplicativos autorizados. A mesma tela de permissões e a mesma lista atendem outros aplicativos compatíveis que conectam sua conta à Raims.

Em aplicativos autenticados, search_raims_documentation permite buscar instruções e exemplos na documentação pública, com trechos e links nas respostas. A busca dispensa uma permissão específica no consentimento. Consultas e operações da conta seguem os acessos que você autorizar.

Conectar sua conta

Adicione a URL do MCP nas configurações do aplicativo compatível.
Inicie a conexão e conclua o login na página da Raims aberta no navegador.
Em Permissões, confira o aplicativo e selecione as operações que ele poderá executar. Use um perfil sugerido ou ajuste cada item.
Selecione Revisar para conferir o aplicativo, a conta, os ambientes, o destino de retorno e as permissões no resumo.
Escolha Autorizar acesso e conclua a confirmação de segurança quando solicitada.
Volte ao aplicativo de IA para continuar.

As operações são independentes e aparecem organizadas por recurso, como Clientes, Cobranças e Webhooks. Marcar criação não seleciona consulta, edição, revogação ou estorno. Use a busca para localizar uma operação e Saiba mais para conferir sua explicação e os ambientes aceitos.

Use Voltar na revisão para ajustar as permissões. A seleção é mantida.

O login mantém os controles de segurança da conta, incluindo MFA quando solicitado. Se não reconhecer o pedido ou não quiser conceder as permissões, feche a página sem autorizar. A conexão só é concedida após a confirmação.

O consentimento autoriza a conexão uma vez. Depois disso, a IA pode executar as operações concedidas sem abrir uma aprovação no Dashboard para cada tarefa. As permissões atuais da conta e as regras de cada recurso continuam valendo.

Se os acessos, os ambientes permitidos ou a situação da conta mudarem durante a conexão, a página pede que você confira novamente os dados e revise os acessos antes de concluir. A autorização não é repetida automaticamente.

O aplicativo compatível pode renovar a autorização sem pedir sua senha novamente. Se a conexão expirar, for revogada ou não puder ser renovada, conecte a conta novamente e confira o consentimento.

Sandbox e Produção usam a mesma URL. Uma nova conexão inclui todos os ambientes permitidos à conta e ao seu acesso, sem escolher um ambiente no consentimento. As permissões selecionadas valem para esses ambientes. Trocar o ambiente do Dashboard não altera o alcance da conexão. Ambientes, recursos e permissões indisponíveis continuam bloqueados.

Se uma conexão estiver limitada a um ambiente, refaça a conexão para autorizar os ambientes atualmente permitidos. Renovar a autorização mantém seu alcance.

Configurar seu aplicativo

Com o Raims CLI instalado, consulte as instruções do cliente:

Shell

raims mcp setup --client codex
raims mcp setup --client claude-code
raims mcp setup --client cursor

O comando apresenta configurações sem credenciais e não executa o aplicativo. --save CAMINHO salva um snippet em um arquivo novo; ele não sobrescreve nem mescla configurações existentes. Confira o plano com --dry-run.

Codex

Shell

codex mcp add raims --url https://mcp.raims.com
codex mcp login raims

Claude Code

Shell

claude mcp add --transport http raims https://mcp.raims.com

Depois, abra o Claude Code, execute /mcp e conclua a autenticação da Raims.

Cursor

Acrescente a entrada abaixo em .cursor/mcp.json ou nas configurações pessoais de MCP do Cursor, preservando os outros servidores:

JSON

{
  "mcpServers": {
    "raims": {
      "url": "https://mcp.raims.com"
    }
  }
}

Conecte o servidor no Cursor e conclua o consentimento no navegador.

Conferir o contexto da conta

Peça ao assistente para consultar get_raims_account_context antes de orientar uma ação que dependa da conta. O assistente informa data_environment como Sandbox ou Production entre os ambientes autorizados. A ferramenta informa a empresa, o ambiente consultado, a situação atual, as capacidades disponíveis e o horário da consulta.

O contexto também descreve moeda, unidades e fuso de referência. Valores financeiros usam centavos inteiros. Previsão de recebimento não é saldo disponível, e uma solicitação aceita não confirma pagamento ou conclusão.

Depois de uma mudança de acesso ou de conta, consulte o contexto novamente. Uma informação indisponível não deve ser tratada como zero. A autorização para iniciar uma chamada não substitui a validação da operação pela Raims.

Executar operações autorizadas

Após autorizar a conexão, peça ao aplicativo as ações que deseja realizar. Por exemplo, ele pode cadastrar, editar ou excluir webhooks quando esses acessos estiverem concedidos. Não é necessário aprovar cada tarefa em outra tela da Raims.

A conexão continua limitada à empresa, aos ambientes autorizados, aos acessos concedidos e às permissões atuais de quem a autorizou. Em cada chamada de raims_api_read, raims_api_write ou get_raims_account_context, o assistente informa o data_environment adequado ao pedido. O resultado identifica o ambiente consultado ou alterado. Limites, saldo, elegibilidade e validações dos recursos são conferidos pela Raims em cada solicitação.

Antes de executar, consulte raims_api_details: o campo data_environments informa quais ambientes o endpoint aceita. O ambiente escolhido precisa ser aceito pelo endpoint e autorizado pela conexão. Simulações aceitam somente Sandbox e não alteram dados de Produção.

Se o resultado de uma escrita ficar incerto, consulte o recurso antes de solicitar outra criação. Um pedido aceito não confirma que um saque chegou ao destino ou que um e-mail foi entregue.

Gerenciar e revogar o acesso

No Dashboard, abra Integração, Aplicativos autorizados. Cada membro pode consultar as próprias conexões. Ver aplicativos da empresa inclui as conexões do titular e da equipe. Revogar conexões da equipe também permite consultá-las e revogar conexões de outros funcionários, sem atingir as do titular. As permissões de dispositivos não concedem esses acessos. No menu de ações, use Editar permissões para conferir os acessos concedidos ou Revogar acesso para encerrar uma conexão, conforme suas permissões. Abrir o editor não altera os acessos.

Editar permissões permite remover ou restaurar acessos da autorização original, com confirmação de segurança, sem mudar ambientes ou validade. Consulte Editar permissões para conferir quem pode editar e quando é necessária uma nova autorização.

As chaves de integração ficam em Integração, Chaves de API e exigem as permissões correspondentes.

Sair do Dashboard não substitui a revogação do aplicativo. Use Revogar acesso para encerrar essa autorização.

A revogação impede novas chamadas autorizadas pela conexão. Ela não desfaz operações concluídas nem apaga dados que o aplicativo externo já tenha recebido. As permissões atuais da conta e do membro da equipe continuam sendo conferidas.

As ações registradas de um funcionário pelo MCP preservam sua identificação em Conta / Registro de Atividades. Cada membro vê as próprias atividades; Ver auditoria completa amplia a consulta para a empresa. O histórico também mostra autorizações, alterações de permissões, revogações e expirações das conexões. Eventos automáticos são identificados como Sistema.

Resolver problemas de conexão

Se uma falha de rede ou indisponibilidade temporária impedir a consulta do pedido de conexão, a página mantém o carregamento e tenta novamente automaticamente enquanto a falha for temporária. Aguarde o resultado. Somente a consulta do pedido é repetida; autorizar o acesso continua exigindo sua confirmação.

Se a solicitação estiver expirada ou não estiver mais disponível, volte ao aplicativo que iniciou a conexão e solicite um novo acesso. Reabrir o mesmo link não renova o pedido.
Se a consulta do pedido for negada, confira a conta e seu acesso atual. Uma negativa de acesso encerra as tentativas automáticas.
Se o aplicativo pedir autenticação novamente, inicie a conexão e confira o consentimento apresentado pela Raims.
Se uma operação não estiver permitida, confira o ambiente, as permissões concedidas e o acesso atual do operador. A conexão não amplia esse acesso.
Se receber DATA_ENVIRONMENT_NOT_ALLOWED, ajuste o pedido para um dos ambientes indicados em raims_api_details.data_environments. Uma nova autorização não libera um ambiente que o endpoint não aceita, nem permite simulações em Produção.
Se a conta estiver diferente do esperado, interrompa a ação e conecte a conta correta. Se o ambiente estiver incorreto, ajuste o pedido ao assistente antes de continuar. Um ambiente fora do alcance da conexão exige nova autorização.
Se o resultado de uma solicitação ficar incerto, confira o estado do recurso antes de pedir outra criação ou repetir a ação.