Referência de ferramentas

Esta página entrega a referência técnica do MCP Rica Pro. Use junto com Catálogo de capacidades para traduzir nomes de ferramentas em fluxos de atendimento.

Contrato público

Toda resposta estruturada segue:

{
  "schemaVersion": "rica-pro-mcp.v1",
  "tipo": "nome_do_contrato",
  "dados": {}
}

Ferramentas de cliente exigem:

{
  "clienteUsuarioId": "id-do-cliente"
}

Ferramentas destrutivas ou externas podem exigir:

{
  "confirmar": true
}

Escopos e status

Classe	Escopo	Status
Leitura e análise	`clientes:read`	Retorna dados públicos sanitizados.
Escrita, remoção e efeitos externos	`clientes:write`	Catalogada com regras de segurança; algumas execuções retornam `executada=false` até ligação ao serviço de domínio compartilhado.

Núcleo

Ferramenta	Uso	Escopo
`listar_clientes`	Lista clientes vinculados ao planejador autenticado.	`clientes:read`
`obter_cliente`	Obtém um cliente específico do planejador.	`clientes:read`
`listar_estruturas_planejador`	Lista estruturas de clientes vinculadas ao planejador.	`clientes:read`
`obter_sessao_cliente`	Retorna resumo público e sanitizado da sessão financeira.	`clientes:read`

Cliente e estrutura

Ferramenta	Uso	Escopo
`listar_pessoas_cliente`	Lista pessoas da estrutura.	`clientes:read`
`listar_projetos_cliente`	Lista projetos.	`clientes:read`
`listar_contas_cliente`	Lista contas.	`clientes:read`
`listar_cartoes_cliente`	Lista cartões de crédito.	`clientes:read`
`listar_categorias_cliente`	Lista categorias.	`clientes:read`
`listar_classes_cliente`	Lista classes.	`clientes:read`
`listar_lancamentos_cliente`	Lista lançamentos com filtros opcionais por pessoa, projeto, conta, categoria e limite.	`clientes:read`
`listar_investimentos_cliente`	Lista investimentos sem payload bruto externo.	`clientes:read`
`listar_instrumentos_cliente`	Lista instrumentos patrimoniais.	`clientes:read`
`listar_objetivos_cliente`	Lista objetivos.	`clientes:read`
`listar_cenarios_cliente`	Lista cenários.	`clientes:read`
`listar_realizacoes_cliente`	Lista realizações.	`clientes:read`
`listar_metas_cliente`	Lista metas.	`clientes:read`
`listar_ciclos_cliente`	Lista ciclos calculados.	`clientes:read`
`listar_projecoes_cliente`	Lista projeções patrimoniais.	`clientes:read`
`listar_documentos_cliente`	Lista metadados de documentos.	`clientes:read`
`listar_anexos_cliente`	Lista metadados de anexos sem senhas ou SAS.	`clientes:read`
`listar_openfinance_cliente`	Lista conexões Open Finance sem tokens ou payloads crus.	`clientes:read`
`listar_b3_cliente`	Lista autorizações B3 com documentos mascarados.	`clientes:read`
`listar_agentes_cliente`	Lista agentes ligados ao cliente.	`clientes:read`
`listar_feedbacks_cliente`	Lista feedbacks ligados ao cliente.	`clientes:read`
`listar_lembretes_cliente`	Lista lembretes ligados ao cliente.	`clientes:read`

Análises do Estúdio

Ferramenta	Uso	Escopo
`analisar_fluxo_caixa_cliente`	Agregações mensais de fluxo de caixa.	`clientes:read`
`analisar_categorizacao_cliente`	Agregações por categoria.	`clientes:read`
`analisar_classificacao_cliente`	Agregações por classe.	`clientes:read`
`analisar_patrimonio_cliente`	Snapshot patrimonial consolidado.	`clientes:read`
`listar_previdencia_social_cliente`	Lista análises de previdência social.	`clientes:read`
`obter_matriz_previdenciaria_cliente`	Retorna disponibilidade de matriz previdenciária.	`clientes:read`
`analisar_cnis_cliente`	Retorna disponibilidade de análises CNIS.	`clientes:read`
`analisar_restituicao_cliente`	Snapshot de dados para restituição.	`clientes:read`
`analisar_protecao_renda_cliente`	Snapshot para proteção de renda.	`clientes:read`
`analisar_otimizacao_prolabore_cliente`	Disponibilidade de cálculo otimizado previdenciário.	`clientes:read`

Mutações de entidades do cliente

Para cada entidade abaixo existem três ferramentas:

criar_<entidade>_cliente;
atualizar_<entidade>_cliente;
remover_<entidade>_cliente.

Entidades cobertas:

pessoa
projeto
conta
cartao
categoria
conceito_categoria
classe
lancamento
investimento
instrumento
objetivo
cenario
realizacao
meta
projecao
documento
anexo

Regras:

criação e atualização exigem clientes:write;
remoção exige clientes:write e confirmar: true;
todas exigem clienteUsuarioId;
execução direta pode retornar executada=false enquanto a ferramenta estiver catalogada sem ligação final ao serviço de domínio.

Exemplo de preparação:

Prepare a chamada para atualizar_lancamento_cliente,
mas não execute. Mostre clienteUsuarioId, lancamentoId e dados propostos.

Open Finance e B3

Ferramenta	Uso	Escopo	Confirmação
`gerar_link_openfinance_cliente`	Gera link público para nova conexão Open Finance.	`clientes:write`	Sim
`remover_openfinance_cliente`	Remove conexão Open Finance.	`clientes:write`	Sim
`configurar_link_b3_cliente`	Cria link de autorização B3.	`clientes:write`	Sim
`sincronizar_b3_cliente`	Enfileira sincronização B3.	`clientes:write`	Sim

Essas ferramentas são openWorldHint. Não retornam token, payload bruto nem documento fiscal completo.

Consultoria e Nexo

Leitura:

Ferramenta	Uso	Escopo
`listar_contatos_consultoria`	Lista contatos.	`clientes:read`
`listar_pipeline_consultoria`	Lista contatos e atendimentos do pipeline.	`clientes:read`
`listar_atendimentos_consultoria`	Lista atendimentos.	`clientes:read`
`listar_agentes_consultoria`	Lista agentes.	`clientes:read`
`listar_feedbacks_consultoria`	Lista feedbacks.	`clientes:read`
`listar_lembretes_consultoria`	Lista lembretes.	`clientes:read`

Entidades com criar_, atualizar_ e remover_:

contato_consultoria
convite_consultoria
mensagem_consultoria
atendimento_consultoria
agente_consultoria
feedback_consultoria
lembrete_consultoria

Remoções exigem confirmar: true. Atendimentos, agentes e feedbacks podem ser openWorldHint.

Configurações do planejador

Leitura:

Ferramenta	Uso	Escopo
`obter_conta_planejador`	Dados públicos permitidos da conta.	`clientes:read`
`listar_assinaturas_planejador`	Assinaturas sem ids sensíveis.	`clientes:read`
`obter_configuracao_usuario_planejador`	Preferências e configurações reduzidas.	`clientes:read`
`listar_catalogo_categorias_planejador`	Catálogo de categorias.	`clientes:read`
`listar_catalogo_classes_planejador`	Catálogo de classes.	`clientes:read`
`listar_catalogo_perfis_planejador`	Perfis de catálogo.	`clientes:read`
`listar_catalogo_templates_planejador`	Templates de estrutura.	`clientes:read`
`listar_tipos_planejador`	Qualificações de tipo.	`clientes:read`
`obter_aparencia_planejador`	Aparência e marca em formato público.	`clientes:read`

Entidades com criar_, atualizar_ e remover_:

categoria_catalogo_planejador
classe_catalogo_planejador
perfil_catalogo_planejador
template_catalogo_planejador

Reinicializações:

Ferramenta	Escopo	Confirmação
`reiniciar_catalogo_categorias_planejador`	`clientes:write`	Sim
`reiniciar_catalogo_classes_planejador`	`clientes:write`	Sim
`reiniciar_catalogo_templates_planejador`	`clientes:write`	Sim

Marketplace

Leitura:

Ferramenta	Uso	Escopo
`listar_lojas_planejador`	Lista lojas.	`clientes:read`
`listar_ofertas_planejador`	Lista ofertas.	`clientes:read`
`listar_paginas_loja_planejador`	Lista páginas e seções.	`clientes:read`
`listar_linhas_virtuais_planejador`	Lista linhas virtuais com números mascarados.	`clientes:read`
`listar_contas_whatsapp_planejador`	Lista contas WhatsApp Business sem ids sensíveis.	`clientes:read`
`listar_chats_atendimento_planejador`	Lista chats de atendimento.	`clientes:read`

Entidades com criar_, atualizar_ e remover_:

loja_planejador
oferta_planejador
pagina_loja_planejador
secao_pagina_loja_planejador
linha_virtual_planejador
conta_whatsapp_planejador
agente_atendimento_planejador

Ações especiais:

Ferramenta	Uso	Escopo	Confirmação
`criar_upload_sas_planejador`	Gera SAS curto para upload.	`clientes:write`	Sim
`criar_cobranca_planejador`	Cria cobrança por provedor externo.	`clientes:write`	Sim
`enviar_mensagem_whatsapp_planejador`	Envia mensagem WhatsApp Business.	`clientes:write`	Sim

Office

Ferramenta	Uso	Escopo
`listar_afiliados_office`	Lista usuários afiliados.	`clientes:read`
`listar_filiadas_office`	Lista contas filiadas.	`clientes:read`
`obter_indicadores_atividade_office`	Retorna indicadores de atividade.	`clientes:read`

Feed e mercado

Ferramenta	Uso	Escopo	Observação
`consultar_bcb`	Consulta dados BCB no contexto do planejador.	`clientes:read`	`openWorldHint`
`consultar_anbima`	Consulta dados ANBIMA.	`clientes:read`	`openWorldHint`
`listar_rentabilidade_consolidada`	Rentabilidade consolidada de mercado.	`clientes:read`	`openWorldHint`
`comparar_mercado`	Comparador ou screener de mercado.	`clientes:read`	`openWorldHint`
`explicar_comparacao_mercado`	Explica uma comparação de mercado.	`clientes:read`	`openWorldHint`

Prompt de auditoria recomendado

Antes de executar, diga o nome da ferramenta MCP Rica Pro,
argumentos principais, escopo exigido, se é destrutiva,
se é openWorldHint e se exige confirmar=true.

Contrato público​

Escopos e status​

Núcleo​

Cliente e estrutura​

Análises do Estúdio​

Mutações de entidades do cliente​

Open Finance e B3​

Consultoria e Nexo​

Configurações do planejador​

Marketplace​

Office​

Feed e mercado​

Prompt de auditoria recomendado​

Links de uso​

Contrato público

Escopos e status

Núcleo

Cliente e estrutura

Análises do Estúdio

Mutações de entidades do cliente

Open Finance e B3

Consultoria e Nexo

Configurações do planejador

Marketplace

Office

Feed e mercado

Prompt de auditoria recomendado

Links de uso