Loading
CRM Analytics
ReferĂȘncia de ferramenta do servidor MCP do CRM Analytics

VocĂȘ estĂĄ aqui:

  1. Ajuda do Salesforce
  2. Documentação
  3. CRM Analytics

ReferĂȘncia de ferramenta do servidor MCP do CRM Analytics

Ferramentas somente leitura que permitem que clientes de IA compatĂ­veis com MCP descubram aplicativos, inspecionem esquemas, executem consultas SAQL e leiam metadados de lens e painel.

EdiçÔes obrigatórias

DisponĂ­vel no Lightning Experience.
Disponível com o CRM Analytics, que estå disponível por um custo extra nas ediçÔes Enterprise, Performance e Unlimited.

Depois de conectar, vocĂȘ mesmo nĂŁo chama essas ferramentas. Faça uma pergunta ao cliente de IA compatĂ­vel com MCP, como ChatGPT, Claude ou Cursor, em linguagem natural. O cliente seleciona as ferramentas para a tarefa.

Por exemplo, quando vocĂȘ pergunta "Quais foram nossas 10 principais contas por receita no Ășltimo ano fiscal?", o cliente de IA inspeciona o esquema do conjunto de dados, gera a Linguagem de consulta do Salesforce Analytics (SAQL) e retorna resultados estruturados com execute_query.

Um fluxo de trabalho de consulta tĂ­pico Ă© list_datasets para get_dataset (capturar currentVersionId) para get_xmd (nomes de campo exatos) para execute_query.

As notas da coluna Descrição/Entradas exigem parùmetros. Outros parùmetros são opcionais.

Ferramentas de organização e descoberta

Clientes de IA externos compatĂ­veis com MCP usam essas ferramentas para localizar pastas (aplicativos) que contĂȘm painĂ©is, conjuntos de dados e lenses e carregar metadados de pasta completos.

Nome da ferramenta Descrição/Entradas Retorna Usar quando
list_folders

Retorna pastas (aplicativos) que o usuĂĄrio conectado pode acessar.

Entradas: q (termos de pesquisa; a ferramenta anexa um curinga ao Ășltimo token), scope (CreatedByMe, Mru, SharedWithMe), sort (Name, Mru, LastModified, LastModifiedBy), isPinned, pageSize (1-200, padrĂŁo 25), page.

 Objetos de pasta com ID, rĂłtulo, descrição, origem do modelo e permissĂ”es. VocĂȘ precisa de IDs de pasta para definir o escopo de chamadas de lista posteriores ou deseja um inventĂĄrio de aplicativos.
get_folder

Retorna metadados completos para uma pasta (aplicativo).

Entradas: folderId (obrigatĂłrio). Descubra IDs com list_folders.

 Um objeto de pasta com rĂłtulo, descrição, origem do modelo e permissĂ”es. VocĂȘ precisa de metadados completos para um aplicativo especĂ­fico.

Ferramentas de dados e esquema

Clientes de IA externos compatĂ­veis com MCP usam essas ferramentas para listar conjuntos de dados e recuperar os nomes de campo, os tipos de dados e os rĂłtulos necessĂĄrios para gerar SAQL vĂĄlido.

Nome da ferramenta Descrição/Entradas Retorna Usar quando
list_datasets

Retorna conjuntos de dados em um aplicativo ou em toda a organização.

Entradas: q, folderId, datasetTypes (Default , Live StagedData, Trended), scope, sort (Name , Mru LastModified, TotalRows CreatedDate, LastRefreshed, CreatedByLastQueried, ConnectionName), order (Ascending , Descending), includeCurrentVersion, pageSize (1–200, padrão 25), page.

 Objetos do conjunto de dados com nomes, tipos e datas da Ășltima modificação. VocĂȘ precisa de nomes e IDs de conjuntos de dados antes de inspecionar um esquema ou executar uma consulta.
get_dataset

Retorna metadados completos para um conjunto de dados, incluindo informaçÔes de versão atual.

Entradas: datasetIdOrApiName (obrigatĂłrio).

 Metadados do conjunto de dados, incluindo nomes de campo, tipos de dados, rĂłtulos de dimensĂŁo e medida e ID da versĂŁo atual. Precisa de currentVersionId antes de ligar para get_xmd ou execute_query.
get_xmd

Retorna metadados estendidos (XMD) para uma versão do conjunto de dados, incluindo nomes de API de campo exato, tipos de dados, rótulos e formatação.

Entradas: datasetIdOrApiName (obrigatório), versionId (obrigatório; ID de 18 caracteres que começa com 0Fc de get_dataset), xmdType (main padrão, pronto para consulta; system; user).

 Metadados estendidos para a versĂŁo do conjunto de dados, incluindo nomes de API de campo, tipos de dados, rĂłtulos e formatação de exibição. VocĂȘ precisa de nomes de API de campo precisos para que o cliente possa criar SAQL sintĂĄticamente correto.

Ferramentas de consulta e anĂĄlise

Clientes de IA externos compatíveis com MCP usam essa ferramenta para executar SAQL em relação a um conjunto de dados do CRM Analytics e retornar resultados estruturados. O cliente gera SAQL da sua solicitação em idioma natural.

Nome da ferramenta Descrição/Entradas Retorna Usar quando
execute_query

Executa uma consulta SAQL com relação a um conjunto de dados do CRM Analytics.

Entradas: query (obrigatĂłrio; pipeline SAQL; estĂĄgio de carga deve usar "<datasetId>/<currentVersionId>"; terminar com q = limit q N;), queryLanguage (bloqueado para Saql), timezone (fuso horĂĄrio no formato IANA, por exemplo, America/Los_Angeles), version (versĂŁo SAQL; omitir para mais recente).

 Resultados da consulta JSON estruturada com linhas, metadados de coluna e detalhes da execução da consulta. VocĂȘ quer respostas agrupadas, filtradas ou classificadas de um conjunto de dados. NĂŁo use essa ferramenta para descoberta de metadados.

Painel, visualização e ferramentas de exploração

Clientes de IA externos compatíveis com MCP usam essas ferramentas para localizar painéis e exploraçÔes salvas (lenses) e para recuperar definiçÔes de widget, etapa, filtro e consulta.

Nome da ferramenta Descrição/Entradas Retorna Usar quando
list_dashboards

Retorna painéis do CRM Analytics em um aplicativo ou em toda a organização.

Entradas: q, folderId, type (padrĂŁo Ă© Dashboard; tambĂ©m DashboardSnapshot, Component – O componente requer acesso de edição e nĂŁo pode retornar resultados para usuĂĄrios somente visualização), templateApiName, mobileOnly, ids, scope, sort, pageSize (1–200, padrĂŁo 25), page.

 Objetos de painel com nomes, IDs, tipos e contexto do aplicativo. VocĂȘ precisa de identificadores de painel ou deseja procurar painĂ©is predefinidos para um aplicativo.
get_dashboard

Retorna metadados completos para um painel, incluindo widgets, etapas e filtros.

Entradas: dashboardIdOrApiName (obrigatĂłrio).

 Metadados completos do painel, incluindo widgets, etapas, configuraçÔes de filtro e detalhes do layout. VocĂȘ precisa da definição completa de um painel especĂ­fico.
list_lenses

Retorna exploraçÔes salvas (lenses) que o usuårio conectado pode acessar.

Entradas: q, folderId, scope, sort, pageSize (1-200, padrĂŁo 25), page.

 Objetos de lens com nomes, IDs e os conjuntos de dados aos quais eles fazem referĂȘncia. VocĂȘ precisa de um inventĂĄrio de exploraçÔes salvas e dos conjuntos de dados que elas usam.
get_lens

Retorna metadados completos para um lens, incluindo a definição de consulta e a referĂȘncia do conjunto de dados.

Entradas: lensIdOrApiName (obrigatĂłrio).

 Metadados de lens completo, incluindo definição de consulta, configuração de visualização e referĂȘncia de conjunto de dados. VocĂȘ precisa dos detalhes de consulta e visualização de um lens especĂ­fico.
 
Carregando
Salesforce Help | Article