Skip to main content
Glama
JoseAlmeida-Ploomes

Ploomes MCP Server

Server Configuration

Describes the environment variables required to run the server.

NameRequiredDescriptionDefault
PLOOMES_DEBUGNoAtiva log de request/response completo no stderr (opcional)
OPENAI_API_KEYNoChave da API OpenAI para debugging com LangSmith (opcional)
PLOOMES_API_KEYYesSua chave de API do Ploomes (obrigatória)
PLOOMES_USER_IDYesID numérico do usuário no Ploomes (obrigatório)
PLOOMES_BASE_URLYesURL base da API do Ploomes (obrigatória, ex: https://api2.ploomes.com)
LANGSMITH_API_KEYNoChave da API LangSmith (opcional)
LANGSMITH_PROJECTNoProjeto LangSmith (opcional, default ploomes-mcp)
LANGSMITH_TRACINGNoHabilita tracing LangSmith (opcional, ex: true)
LANGSMITH_ENDPOINTNoEndpoint do LangSmith (opcional, default https://api.smith.langchain.com)
PLOOMES_AI_BASE_URLNoURL base da API de AI (opcional, default https://ai.ploomes.run/api)
PLOOMES_AI_CLIENT_IDNoClient ID para feature de geração de HTML de proposta (opcional)
PLOOMES_AI_CLIENT_SECRETNoClient Secret para feature de geração de HTML de proposta (opcional)

Capabilities

Features and capabilities supported by this server

CapabilityDetails
tools
{
  "listChanged": false
}
prompts
{
  "listChanged": false
}
resources
{
  "subscribe": false,
  "listChanged": false
}
experimental
{}

Tools

Functions exposed to the LLM to take actions

NameDescription
buscar_clientesC
    🎯 Objetivo:
        1. Busca clientes (empresas ou contatos).
        2. Busca contatos de empresa (por exemplo: João da Sunhub).

    🔍 Instruções para buscar os contatos de uma empresa:
        1. Primeiro chame a tool buscar_clientes para buscar o ID da empresa.
        2. Depois chame a tool buscar_clientes novamente para buscar os clientes relacionados ao ID da empresa pai.

    🔍 Observações:
        1. Só use o campo STATUS quando o pedido explicitar qual o status.
        2. Use o campo id_da_empresa_pai quando quiser buscar por contatos de alguma empresa, por exemplo: João da GlobalTech.
        3. NÃO tente preencher o tipo a partir do contexto da frase ou de situações genéricas (como 'clientes da região XXXXX'). O campo "tipo" deve ser preenchido em duas situações:
            - Se o usuário indicar explicitamente o tipo.
            - Se o nome do cliente for mencionado (tente prever pelo nome como por exemplo, 'João' → PESSOA, 'Microsoft' → EMPRESA).
    
salvar_clienteA
    Criar ou atualizar um cliente/contato no Ploomes CRM.

    Passe o ID para atualizar um cliente existente.

    Observacoes:
        1. Use buscar_clientes para obter o ID de um cliente existente.
        2. Use buscar_tipos_contato para obter o TypeId (1=Empresa, 2=Pessoa).
        3. Use buscar_cidades para obter o CityId.
        4. Use buscar_segmentos para obter o LineOfBusinessId.
        5. Use buscar_origens_contato para obter o OriginId.
        6. data_nascimento deve estar no formato ISO 8601: "YYYY-MM-DDTHH:MM:SS-03:00"
        7. cnpj e cpf devem ser passados apenas com dígitos, sem formatação.
        8. campos_customizados deve seguir o formato: [{"FieldKey": "chave", "StringValue": "valor"}]
    
excluir_clienteA
    Excluir um cliente/contato do Ploomes CRM.

    Pre requisitos:
        1. Busque o ID do cliente a ser excluido usando buscar_clientes.
    
buscar_cargos_de_clientesC
    🔍 Observações:
      1. O resultado da busca é limitado a resultados por página. Você pode acessar a próxima página usando o parâmetro pagina.
    
buscar_segmentosB
    🎯 Objetivo:
      1. Buscar opções de segmentos de empresas.

    🔍 Observações:
      1. O resultado da busca é limitado a resultados por página. Você pode acessar a próxima página usando o parâmetro pagina.
    
buscar_origens_contatoC
    Buscar origens de contato no Ploomes CRM.

    Observacoes:
        1. Use para obter o OriginId ao criar/atualizar um cliente.
    
salvar_origem_contatoB

Criar ou atualizar uma origem de contato no Ploomes CRM.

Passe o ID para atualizar uma origem existente.

excluir_origem_contatoC

Excluir uma origem de contato do Ploomes CRM.

buscar_numero_funcionariosA
    Buscar opcoes de numero de funcionarios no Ploomes CRM.

    Observacoes:
        1. Use para obter o NumberOfEmployeesId ao criar/atualizar um cliente.
    
salvar_numero_funcionariosA

Criar ou atualizar uma opcao de numero de funcionarios no Ploomes CRM.

Passe o ID para atualizar uma opcao existente.

excluir_numero_funcionariosC

Excluir uma opcao de numero de funcionarios do Ploomes CRM.

salvar_segmentoA

Criar ou atualizar um segmento/ramo de atividade no Ploomes CRM.

Passe o ID para atualizar um segmento existente.

excluir_segmentoC

Excluir um segmento/ramo de atividade do Ploomes CRM.

buscar_relacionamentos_contatoC

Buscar tipos de relacionamento de contato no Ploomes CRM.

buscar_status_contatoC

Buscar opcoes de status de contato no Ploomes CRM.

buscar_tipos_contatoA
    Buscar tipos de contato no Ploomes CRM.

    Observacoes:
        1. Use para obter o TypeId ao criar/atualizar um cliente (1=Empresa, 2=Pessoa).
    
buscar_produtos_contatoC

Buscar produtos associados a contatos no Ploomes CRM.

salvar_produto_contatoB

Associar ou atualizar um produto a um contato no Ploomes CRM.

Passe o ID para atualizar uma associacao existente.

excluir_produto_contatoC

Excluir uma associacao de produto a contato do Ploomes CRM.

resumir_clienteA
    Use essa tool quando o usuário explicitamente pedir o resumo de um cliente
    Utilize somente o parâmetro assunto se o usuário explicitamente pedir o resumo de um cliente para um assunto específico.
    O parâmetro assunto filtra os registros de interações do cliente para mostrar apenas os que contém a palavra-chave informada.
    🔍 Pré requisitos:
        1. Você deve chamar a tool buscar_clientes para buscar o id do cliente a ser resumido.
    
buscar_negocioA
    🎯 Objetivo:
      1. Busca negócios (deals) no sistema Ploomes CRM e retorna os dados do negócio e o número de ocorrências conforme os filtros especificados.

    ℹ️ Informações úteis:
        - Formato para datas: YYYY-MM-DDTHH:MM:SS-03:00
        - Por padrão, os negócios são ordenados por data de última atualização. Para mostrar os negócios mais recentes ou mais antigos, ordene por CreateDate.

    📋 Prerequisitos:
      1. Faça o menor número de chamadas possíveis para obter os dados necessários.
      2. Se o usuário pedir para calcular o valor total das oportunidades, use 'calcular_valor_total = True', a informação será retornada no campo 'total_amount'.
      3. Usar buscar_contato para obter o id_cliente do cliente.
      4. Usar buscar_pipeline para obter o id_pipeline do pipeline.
      5. Usar buscar_pipeline para obter o id_etapa_pipeline do estágio do negócio dentro do pipeline.
      6. Usar buscar_razao_perda para obter o id_razao_perda da razão de perda do negócio.
      7. Usar buscar_marcadores para obter o id_marcador do marcador.
    
salvar_negocioB
    Criar ou atualizar um negocio no Ploomes CRM.

    Passe o ID para atualizar um negocio existente.

    Observacoes:
        1. Use buscar_clientes para obter o ContactId (empresa ou contato principal).
        2. Use buscar_clientes(tipo=PESSOA) para obter o PessoaId (contato pessoa relacionado).
        3. Use buscar_pipeline para obter o PipelineId e StageId.
        4. Use buscar_usuarios para obter o OwnerId e ids dos colaboradores.
        5. data_inicio deve estar no formato ISO 8601: "YYYY-MM-DDTHH:MM:SS-03:00".
        6. usuarios_colaboradores deve ser uma lista de IDs de usuários: [123, 456].
        7. campos_customizados deve seguir o formato: [{"FieldKey": "chave", "StringValue": "valor"}]
    
excluir_negocioA
    Excluir um negocio do Ploomes CRM.

    Pre requisitos:
        1. Busque o ID do negocio a ser excluido usando buscar_negocio.
    
acoes_negocioA
    Executar acoes em um negocio: ganhar, perder ou reabrir.

    Observacoes:
        1. Use buscar_negocio para obter o ID do negocio.
        2. Use buscar_razao_perda para obter o LossReasonId ao perder um negocio.
        3. A acao PERDER requer o razao_perda_id.
    
buscar_etapas_negocioA
    Buscar etapas de negocios no Ploomes CRM.

    Observacoes:
        1. Use para obter o StageId ao criar/atualizar um negocio.
        2. Filtre por pipeline_id para ver as etapas de um funil especifico.
    
buscar_status_negocioB
    Buscar opcoes de status de negocio no Ploomes CRM.

    Retorna os status possiveis: Aberto, Ganho, Perdido, etc.
    
buscar_propostaB
    🔍 Observações:
      - Caso não especificado, ordernar por CreateDate desc para mostrar propostas mais recentes.
      - Caso peçam para filtrar a busca por equipe, use a tool buscar_equipes_de_usuarios para buscar o id da equipe, quando necessário, peça para que o usuário especifique o nome da equipe.
      - O campo descricao_entrega é um campo de texto descrevendo a previsão de entrega da proposta, como 'semana que vem', '10 dias', '2 semanas', etc.
      - O campo Approver é um campo booleano que indica se a proposta está aguardando aprovação do usuário logado.
      - Uma proposta é identificada pelos campos QuoteNumber e Id. Cada proposta pode ter várias revisões, o número da revisão é indicado pelo campo ReviewNumber (numero_da_revisao). O campo Id é diferente para cada revisão, enquanto o campo QuoteNumber é o mesmo para todas as revisões de uma mesma proposta.
    
salvar_propostaA
    Criar ou atualizar uma proposta/cotacao no Ploomes CRM.

    Passe o ID para atualizar uma proposta existente.

    Observacoes:
        1. Use buscar_negocio para obter o DealId.
        2. Use buscar_clientes(tipo=EMPRESA) para obter o ContactId e buscar_clientes(tipo=PESSOA) para o PessoaId.
        3. Use buscar_templates_documentos para obter o TemplateId.
        4. data_validade deve estar no formato ISO 8601: "YYYY-MM-DDTHH:MM:SS-03:00".
        5. produtos deve seguir o formato: [{"ProductId": 1, "Quantity": 2, "UnitPrice": 100.0}]
        6. campos_customizados deve seguir o formato: [{"FieldKey": "chave", "StringValue": "valor"}]
    
excluir_propostaB
    Excluir uma proposta/cotacao do Ploomes CRM.

    Pre requisitos:
        1. Busque o ID da proposta a ser excluida usando buscar_proposta.
    
revisar_propostaB
    Enviar uma proposta para revisao no Ploomes CRM.

    Pre requisitos:
        1. Busque o ID da proposta usando buscar_proposta.
    
buscar_status_aprovacao_propostaC

Buscar status de aprovacao de propostas no Ploomes CRM.

Retorna os status possiveis de aprovacao de propostas/cotacoes.

buscar_templates_propostaB
    Buscar templates de propostas no Ploomes CRM.

    Observacoes:
        1. Use para obter o TemplateId ao criar propostas.
    
buscar_pipelineA
    🎯 Objetivo:
      1. Busca a lista de pipelines / funis no sistema Ploomes CRM.

    Args:
        pagina: Número da página a ser buscada.
        nome_pipeline: Texto para filtrar o nome do pipeline/funil. Se não for fornecido, busca todos os pipelines/funis.
        nome_etapa: Texto para filtrar o nome da etapa. Se não for fornecido, busca todas as etapas.
    
salvar_pipelineA
    Criar ou atualizar um pipeline/funil de negócios no Ploomes CRM.

    Passe o ID para atualizar um pipeline existente.

    Observações:
        1. Use buscar_pipeline para obter o ID de um pipeline existente.
        2. etapas deve seguir o formato:
           [
             {
               "Name": "Prospecção",
               "Ordination": 1,
               "Color": "#4CAF50",
               "MaxDays": 7,
               "WinStage": false,
               "LoseStage": false
             },
             ...
           ]
        3. Ao criar um pipeline, as etapas são definidas junto com ele.
        4. Color da etapa deve ser um valor hexadecimal (ex: "#4CAF50").
        5. MaxDays define o número máximo de dias recomendados na etapa (pode ser null).
        6. WinStage e LoseStage marcam etapas de ganho e perda do negócio.
        7. icone_id: ID do ícone FontAwesome. Use buscar_icones_pipeline para listar opções.
        8. cor: Cor hexadecimal do pipeline (ex: "#2196F3").
        9. nome_singular / nome_plural / genero_id permitem configurar a nomenclatura do funil.
       10. tipo_funil aplica automaticamente ícone e nomenclatura padrão quando estes campos
           não forem informados manualmente.
       11. As duas visualizações (tabela e funil) são habilitadas por padrão ao criar.

    Tipos de funil aceitos em tipo_funil (exemplos):
        - aquisicao_clientes
        - marketing_leads
        - vendas_carteira
        - assistencia_tecnica
        - reativacao_clientes
        - pos_venda
        - onboarding_implantacao
        - cobranca
        - contratos
        - suporte
        - logistica
        - proposta_orcamento
    
excluir_pipelineA
    Excluir um pipeline/funil de negocios do Ploomes CRM.

    Pre requisitos:
        1. Busque o ID do pipeline a ser excluido usando buscar_pipeline.
    
buscar_razao_perdaA
    🎯 Objetivo:
        No CRM Ploomes, um negócio pode ser perdido por diferentes razões.
        Essa tool retorna uma lista de razões de perda de negócio baseado numa busca por palavras chave.

    Args:
        palavras_chave: Lista de palavras chave para a busca. Procure por uma palavra chave que possam estar na razão de perda.
        pagina: Número da página a ser buscada.
    
buscar_checklists_etapaB
    Buscar checklists de etapas de pipeline no Ploomes CRM.

    Observacoes:
        1. Use buscar_etapas_negocio para obter o etapa_id (DealStageId).
        2. Filtre por etapa_id para ver os checklists de uma etapa específica.
        3. Filtre por id para buscar um checklist específico.
    
salvar_checklist_etapaA
    Criar ou atualizar um checklist de etapa de pipeline no Ploomes CRM.

    Passe o ID para atualizar um checklist existente.

    Observacoes:
        1. Use buscar_etapas_negocio para obter o etapa_id (DealStageId).
        2. Use buscar_checklists_etapa para obter o ID de um checklist existente.
        3. nomes_campos é uma lista de nomes de campos a incluir no checklist.
           Para cada nome, a tool busca o campo na entidade Negócio (Deal).
           Se o campo não existir, ele é criado automaticamente como Texto multilinha.
        4. texto_informativo (FillingInfo) é exibido como dica ao passar o mouse no ícone do checklist.
    
excluir_checklist_etapaB
    Excluir um checklist de etapa de pipeline do Ploomes CRM.

    Pre requisitos:
        1. Use buscar_checklists_etapa para obter o ID do checklist a ser excluido.
    
buscar_icones_pipelineA
    Listar os ícones disponíveis para pipelines no Ploomes CRM.

    Retorna o ID e a classe FontAwesome de cada ícone.
    Use o IconId ao criar ou atualizar um pipeline com salvar_pipeline.
    
buscar_formulario_pipelineA
    Buscar a estrutura do formulário de criação/edição de negócios de um pipeline.

    Retorna as seções e campos configurados no formulário.

    Observacoes:
        1. Use buscar_pipeline para obter o pipeline_id.
        2. formulario_rapido=True retorna o QuickForm (form simplificado de criação rápida).
        3. Use salvar_secao_formulario_pipeline e salvar_campo_formulario_pipeline para editar.

    Campos disponíveis (FieldKey):
        deal_title, deal_amount, deal_currency, deal_contact, deal_person,
        deal_tags, deal_origin, deal_owner, deal_start_date,
        deal_collaborating_users, deal_products
    
salvar_secao_formulario_pipelineA
    Criar ou atualizar uma seção no formulário de negócios de um pipeline.

    Passe o ID para atualizar uma seção existente.

    Observacoes:
        1. Use buscar_pipeline para obter o pipeline_id.
        2. Use buscar_formulario_pipeline para ver as seções existentes e seus IDs.
        3. ordenacao define a posição da seção no formulário (menor = mais acima).
           Se não informado, a seção é adicionada ao final.
        4. formulario_rapido=True cria no QuickForm (criação rápida).
        5. Após criar a seção, use salvar_campo_formulario_pipeline para adicionar campos.
    
salvar_campo_formulario_pipelineA
    Adicionar ou mover um campo no formulário de negócios de um pipeline.

    Se o campo (FieldKey) já existir no formulário, ele é movido para a
    seção/posição indicada em vez de ser duplicado.

    Passe o ID do campo para atualizar diretamente sem busca prévia.

    Observacoes:
        1. Use buscar_formulario_pipeline para obter o form_id, secao_id e IDs de campos.
        2. chave_campo (FieldKey) deve ser uma das chaves nativas de negócio:
           - deal_title: Título do negócio
           - deal_amount: Valor
           - deal_currency: Moeda
           - deal_contact: Empresa (contato principal)
           - deal_person: Pessoa de contato
           - deal_tags: Marcadores
           - deal_origin: Origem
           - deal_owner: Responsável
           - deal_start_date: Data de início
           - deal_collaborating_users: Usuários colaboradores
           - deal_products: Produtos
           Para campos customizados, use a chave retornada por buscar_campos_entidades.
        3. largura_total=True faz o campo ocupar a linha inteira do formulário.
        4. ordenacao define a posição dentro da seção (menor = mais acima).
        5. Se secao_id não for informado, o campo fica no topo do formulário (sem seção).
    
excluir_secao_formulario_pipelineA
    Excluir uma seção do formulário de negócios de um pipeline.

    Atencao: excluir a seção remove também todos os campos dentro dela.

    Pre requisitos:
        1. Use buscar_formulario_pipeline para obter o ID da seção.
    
excluir_campo_formulario_pipelineA
    Remover um campo de uma seção do formulário de negócios de um pipeline.

    Pre requisitos:
        1. Use buscar_formulario_pipeline para obter o ID do campo.
    
buscar_tabelas_opcoesA
    Buscar tabelas de opções pré-cadastradas no Ploomes CRM.

    Observacoes:
        1. Use para localizar a tabela de opções antes de criar campos do tipo
           opções pré-cadastradas (TypeId 7) ou itens de checklist.
        2. Por padrão, nome aplica filtro EXATO por Name — é o comportamento
           esperado por quem usa esta tool para conferir se uma tabela já
           existe antes de criar (ver salvar_tabela_opcoes).
        3. busca_parcial=True troca o filtro para "contém", útil para
           explorar a conta quando você não sabe o nome exato.
        4. id filtra por uma tabela específica (Id da OptionsTable) — atalho
           para conferir uma tabela que você já conhece.
    
buscar_opcoes_tabela_opcoesB
    Buscar opções de uma tabela de opções pré-cadastradas.

    Observacoes:
        1. Use para verificar quais opções já existem antes de criar novas.
        2. tabela_id é o Id da OptionsTable.
    
salvar_tabela_opcoesA
    Criar, atualizar ou garantir a existência de uma tabela de opções
    pré-cadastradas no Ploomes CRM.

    Observacoes:
        1. Sem id e com garantir_existencia=true (default): busca a tabela
           pelo nome e só cria se ainda não existir — é o modo seguro para
           usar dentro de um fluxo de montagem de checklist/campo, porque
           rodar duas vezes não duplica a tabela.
        2. Sem id e com garantir_existencia=false: cria sempre uma tabela
           nova, mesmo que já exista outra com o mesmo nome.
        3. Com id informado: RENOMEIA a tabela existente (PATCH em
           Fields@OptionsTables). Use buscar_tabelas_opcoes para achar o Id.
           Atenção: renomear afeta todos os campos que já usam essa tabela.
        4. Depois de ter a tabela, use salvar_opcao_tabela_opcoes (uma
           opção) ou garantir_opcoes_tabela_opcoes (lista inteira) para
           popular as opções.
    
salvar_opcao_tabela_opcoesC

Criar uma opção em uma tabela de opções pré-cadastradas no Ploomes CRM.

garantir_opcoes_tabela_opcoesC
    Garantir que uma tabela tenha todas as opções desejadas no Ploomes CRM.

    Observacoes:
        1. Cria apenas as opções que ainda não existem.
        2. Útil para campos do tipo opções pré-cadastradas em checklists.
    
buscar_field_pathsA
    Buscar FieldPaths disponíveis a partir de uma entidade no Ploomes CRM.

    Observacoes:
        1. entity_id=2 representa Negócio (Deal).
        2. Use para investigar os caminhos possíveis antes de montar itens de checklist.
    
resolver_field_path_checklistA
    Resolver o FieldPathId correto para um item de checklist de negócio.

    Observacoes:
        1. Quando destination_entity_id não for informado, a tool tenta inferir pelo prefixo do field_key.
        2. Para checklist de negócios, source_entity_id normalmente é 2.
    
buscar_campo_dinamico_existenteA
    Buscar um campo dinâmico existente no Ploomes CRM.

    Observacoes:
        1. Filtra por Dynamic=true.
        2. Útil antes de montar checklists para reaproveitar campos já existentes.
    
buscar_field_key_por_field_idC
    Buscar o FieldKey de um campo pelo field_id.
    
garantir_campo_dinamico_checklistA
    Garantir um campo dinâmico pronto para uso em checklist no Ploomes CRM.

    Observacoes:
        1. Se o campo já existir, ele será reaproveitado.
        2. Para tipo_id=7 (opções pré-cadastradas), a tool garante a tabela e as opções antes de criar o campo.
        3. Retorna field_id e field_key, necessários para montar os itens do checklist.
    
salvar_filtro_checklistA
    Criar o filtro padrão usado por checklists de etapa no Ploomes CRM.

    Observacoes:
        1. Para 'Dados Pessoa Física', cria o filtro de contato tipo pessoa física.
        2. Para 'Dados Empresa', cria o filtro de contato tipo empresa.
        3. Nos demais casos usa '$filter=true'.
    
salvar_checklist_etapa_completoB
    Criar ou atualizar um checklist de etapa de forma compatível com o front do Ploomes CRM.

    Cada item aceita, por exemplo:
        {
          "label": "CNPJ",
          "field_name": "CNPJ",
          "entity_id": 2,
          "type_id": 2,
          "required": true,
          "operation_id": 2
        }

    Para campos de opções pré-cadastradas (type_id=7), envie também:
        {
          "options_table": "Tabela Tipo de Documento",
          "options": ["CPF", "RG", "CNH"]
        }

    Observacoes:
        1. A tool garante campos dinâmicos, FieldKey, FieldPathId e o filtro do checklist.
        2. Usa DealFilterId no body final para que o checklist abra corretamente no front.
        3. checklist_id é opcional e permite atualizar um checklist existente.
    
buscar_vendasB
    Objetivo:
      1. Busca vendas (orders) ativos no sistema Ploomes CRM e retorna os dados da venda e o número de ocorrências conforme os filtros especificados.

    Informações úteis:
        - Formato para datas: YYYY-MM-DDTHH:MM:SS-03:00
        - Caso não especificado, ordernar por CreateDate para mostrar as vendas mais recentes.
        - Quando for informado que determinado usuário vendeu algo, assuma que a venda é daquele usuário
        - Vendas de usuário são aquelas em o "id_dono" é o id do usuário.
        - Use o parâmetro "id_produto" para filtrar vendas que contenham um produto específico.
    Prerequisitos:
      1. Faça o menor número de chamadas possíveis para obter os dados necessários.
    
salvar_vendaB
    Criar ou atualizar um pedido/venda no Ploomes CRM.

    Passe o ID para atualizar um pedido existente.

    Observacoes:
        1. Use buscar_negocio para obter o DealId.
        2. Use buscar_clientes(tipo=EMPRESA) para o ContactId e buscar_clientes(tipo=PESSOA) para o PessoaId.
        3. Use buscar_vendas_config para obter o StageId e TemplateId.
        4. agente_id é o ID do representante comercial vinculado à venda.
        5. comissao_percentual é o percentual de comissão do agente (ex: 5.0 para 5%).
        6. produtos deve seguir o formato: [{"ProductId": 1, "Quantity": 2, "UnitPrice": 100.0}]
        7. campos_customizados deve seguir o formato: [{"FieldKey": "chave", "StringValue": "valor"}]
    
excluir_vendaA
    Excluir um pedido/venda do Ploomes CRM.

    Pre requisitos:
        1. Busque o ID do pedido a ser excluido usando buscar_vendas.
    
buscar_etapas_vendaB
    Buscar etapas de pedidos/vendas no Ploomes CRM.

    Observacoes:
        1. Use para obter o StageId ao criar/atualizar um pedido.
    
salvar_etapa_vendaC

Criar ou atualizar uma etapa de pedido/venda no Ploomes CRM.

Passe o ID para atualizar uma etapa existente.

excluir_etapa_vendaC

Excluir uma etapa de pedido/venda do Ploomes CRM.

buscar_documentosB
    🎯 Objetivo:
        1. Buscar documentos/contratos.

    🔍 Pré requisitos:
        1. Você deve chamar a tool buscar_contato antes para buscar o id do contato se for informado algum contato.
        2. Você deve chamar a tool buscar_usuario antes para buscar o id do usuário se for informado algum usuário ou dono/proprietário/responsável.

    🔍 Observações:
        1. O resultado da busca é limitado a itens por página. Você pode acessar a próxima página usando o parâmetro pagina.
        2. Quando o usuário se referir com pronomes possessivos ao documento considere que ele é o Responsável, *NÃO CONSIDERE* que ele é o criador somente por esse fator.
    
salvar_documentoA
    Criar ou atualizar um documento/contrato no Ploomes CRM.

    Passe o ID para atualizar um documento existente.

    Observacoes:
        1. Use buscar_clientes para obter o ContactId.
        2. Use buscar_templates_documentos para obter o TemplateId.
        3. campos_customizados deve seguir o formato: [{"FieldKey": "chave", "StringValue": "valor"}]
    
excluir_documentoA
    Excluir um documento/contrato do Ploomes CRM.

    Pre requisitos:
        1. Busque o ID do documento a ser excluido usando buscar_documentos.
    
buscar_templates_documentosC
    Buscar templates de documentos no Ploomes CRM.

    Observacoes:
        1. Use para obter o TemplateId ao criar propostas ou documentos.
    
buscar_produtosC
    🔍 Informações Gerais:
    - O parâmetro 'pagina' deve ser um número inteiro positivo maior que 0.
    - O parâmetro 'moeda_codigo' filtra produtos pela moeda usando o código ISO (ex: 'BRL', 'USD', 'EUR').
    - Caso não especificado, ordena por CreateDate desc para mostrar produtos mais recentes.
    
salvar_produtoB
    Criar ou atualizar um produto no Ploomes CRM.

    Passe o ID para atualizar um produto existente.

    Observacoes:
        1. Use buscar_grupos_produto para obter o GroupId.
        2. Use buscar_familias_produto para obter o FamilyId.
        3. Use buscar_moedas para obter o CurrencyId.
        4. campos_customizados deve seguir o formato: [{"FieldKey": "chave", "StringValue": "valor"}]
    
excluir_produtoA
    Excluir um produto do Ploomes CRM.

    Pre requisitos:
        1. Busque o ID do produto a ser excluido usando buscar_produtos.
    
buscar_familias_produtoB
    Buscar familias de produtos no Ploomes CRM.

    Observacoes:
        1. Use para obter o FamilyId ao criar/atualizar um produto.
    
salvar_familia_produtoB

Criar ou atualizar uma familia de produto no Ploomes CRM.

Passe o ID para atualizar uma familia existente.

excluir_familia_produtoC

Excluir uma familia de produto do Ploomes CRM.

buscar_grupos_produtoC
    Buscar grupos de produtos no Ploomes CRM.

    Observacoes:
        1. Use para obter o GroupId ao criar/atualizar um produto.
    
salvar_grupo_produtoA

Criar ou atualizar um grupo de produto no Ploomes CRM.

Passe o ID para atualizar um grupo existente.

excluir_grupo_produtoC

Excluir um grupo de produto do Ploomes CRM.

buscar_pecas_produtoC

Buscar pecas/componentes de produtos no Ploomes CRM.

salvar_peca_produtoC

Criar ou atualizar uma peca/componente de produto no Ploomes CRM.

Passe o ID para atualizar uma peca existente.

excluir_peca_produtoB

Excluir uma peca/componente de produto do Ploomes CRM.

buscar_marcadoresD
    🔍 Parâmetros:
      2. São retornados no máximo 20 marcadores por página.
      3. O parâmetro pagina é um número inteiro que representa a página da busca.
    
salvar_marcadorA
    Criar ou atualizar um marcador/tag no Ploomes CRM.

    Passe o ID para atualizar um marcador existente.

    Observacoes:
        1. Use buscar_marcadores para obter o ID de um marcador existente.
        2. entidade_id: 1=Clientes, 2=Tarefas, 5=Negocios, 7=E-mail.
    
excluir_marcadorA
    Excluir um marcador/tag do Ploomes CRM.

    Pre requisitos:
        1. Busque o ID do marcador a ser excluido usando buscar_marcadores.
    
salvar_campoC
    Criar ou atualizar um campo customizado no Ploomes CRM.

    Passe a chave (Key) para atualizar um campo existente.

    Observacoes:
        1. Use buscar_entidades_campos para obter o EntityId.
        2. Use buscar_tipos_campo para obter o TypeId.
        3. Use buscar_tabelas_opcoes para obter o OptionsTableId (para campos do tipo lista).
        4. O campo Key eh retornado ao criar o campo e deve ser usado para salvar valores em OtherProperties.
    
excluir_campoA
    Excluir um campo customizado do Ploomes CRM.

    Pre requisitos:
        1. Busque a chave (Key) do campo a ser excluido usando buscar_schema.
    
excluir_tabela_opcoesC

Excluir uma tabela de opcoes do Ploomes CRM.

buscar_opcoes_tabelaC
    Buscar opcoes de uma tabela de opcoes no Ploomes CRM.

    Observacoes:
        1. Informe o tabela_id para filtrar opcoes de uma tabela especifica.
    
salvar_opcao_tabelaA
    Criar ou atualizar uma opcao em uma tabela de opcoes no Ploomes CRM.

    Observacoes:
        1. Passe o ID para atualizar uma opcao existente.
        2. A ordem define a posicao da opcao na lista.
    
excluir_opcao_tabelaC

Excluir uma opcao de uma tabela de opcoes do Ploomes CRM.

buscar_secoes_campoB
    Buscar secoes de campos personalizados no Ploomes CRM.

    Observacoes:
        1. Use para obter o SectionId ao criar campos personalizados.
        2. Filtre por entidade_id para ver secoes de uma entidade especifica.
    
salvar_secao_campoB
    Criar ou atualizar uma secao de campos personalizados no Ploomes CRM.

    Observacoes:
        1. Secoes organizam campos em grupos visuais na interface.
        2. Passe o ID para atualizar uma secao existente.
    
excluir_secao_campoC

Excluir uma secao de campos personalizados do Ploomes CRM.

buscar_camposA
    Buscar campos personalizados no Ploomes CRM.

    Observacoes:
        1. Use para verificar se um campo ja existe antes de criar.
        2. entidade_id=2 filtra campos de Negocios (Deal) — padrao se nao informado.
        3. Retorna Id e Key dos campos, necessarios para montar items de checklist.
        4. Key tem o formato: deal_<UUID> para campos de negocio.
    
buscar_entidades_campoA
    Buscar entidades disponiveis para campos personalizados no Ploomes CRM.

    Observacoes:
        1. Use para obter o EntityId ao criar campos personalizados.
        2. Retorna as entidades que suportam campos customizados (ex: Contatos, Negocios, etc).
    
buscar_tipos_campoB
    Buscar tipos de campo personalizados disponiveis no Ploomes CRM.

    Observacoes:
        1. Use para obter o TypeId ao criar campos personalizados.
        2. Tipos comuns: Texto, Numero, Data, Selecao, Multi-selecao, etc.
    
salvar_tarefaB
    🎯 Objetivos:
        1. Criar uma nova tarefa.
        2. Atualizar os dados de uma tarefa existente.
    🔍 Observações:
        1. Usar buscar_clientes para obter o ID do contato principal ou contatos relacionados.
        2. Usar buscar_usuarios para obter o ID dos usuarios marcados.
        3. Usar buscar_tarefas_extras para obter IDs de lembretes por e-mail e unidades de repetição.
        4. Passar o ID da tarefa caso queria atualizar os seus dados.
    
buscar_tarefasC
    🔍 Pré requisitos:
        1. Você deve chamar a tool buscar_contato antes para buscar o id do contato se for informado algum contato.
        2. Você deve chamar a tool buscar_usuario antes para buscar o id do usuário se for informado algum usuário ou dono/proprietário da tarefa.
        3. Você deve chamar a tool buscar_negocio antes para buscar o id do negócio se for informado algum negócio.
        4. Você deve chamar a tool buscar_marcadores antes para buscar o id do marcador se for informado algum marcador.
        5. Você deve chamar a tool buscar_segmentos antes para buscar o id do segmento se for informado algum segmento de cliente.

    🔍 Observações:
      1. O resultado da busca é limitado a itens por página. Você pode acessar a próxima página usando o parâmetro pagina.
      2. Passe o ID do usuário logado quando o pedido for uma consulta pessoal, por exemplo: "minhas reuniões", "minha agenda", "minhas tarefas".
      3. Quando o tipo pedido pelo usuário não for explicitamente um dos permitidos(SIMPLES, VISITA, TELEFONE, EMAIL, REUNIAO, CONFERENCIA, WHATSAPP), pergunte ao usuário o tipo.
    
buscar_horarios_disponiveisA
    🎯 Objetivo:
      1. Buscar horários disponíveis em um período de tempo.

    🔍 Pré requisitos:
        1. Você deve chamar a tool buscar_usuario antes para buscar o id do usuário se for informado algum usuário.
        2. Você deve chamar a tool buscar_equipes_de_usuarios antes para buscar o id da equipe se for informada uma equipe.

    🔍 Observações:
        1. O range máximo entre a data_inicio e a data_fim é de 7 dias.
        2. SEMPRE considere pessoas mencionadas como usuários.
    
finalizar_tarefaD
    Pré requisitos:
        1. Busque o ID da tarefa a ser finalizada.
    
excluir_tarefaD
    Pré requisitos:
        1. Busque o ID da tarefa a ser excluída.
    
buscar_tipos_tarefaB
    Buscar tipos de tarefa no Ploomes CRM.

    Observacoes:
        1. Use para obter o TypeId ao criar/atualizar uma tarefa.
        2. Tipos comuns: Simples, Visita, Telefone, Email, Reuniao, Conferencia, WhatsApp.
    

Prompts

Interactive templates invoked by user choice

NameDescription

No prompts

Resources

Contextual data attached and managed by the client

NameDescription

No resources

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/JoseAlmeida-Ploomes/ploomes-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server