Loading
CRM Analytics
Riferimento per lo strumento server MCP CRM Analytics

Riferimento per lo strumento server MCP CRM Analytics

Strumenti di sola lettura che consentono ai client AI conformi a MCP di scoprire app, esaminare schemi, eseguire query SAQL e leggere metadati di cruscotti digitali e lenti.

Versioni (Edition) richieste

Disponibile in Lightning Experience.
Disponibile con CRM Analytics, disponibile a sua volta con un supplemento di prezzo nelle versioni Enterprise Edition, Performance Edition e Unlimited Edition.

Dopo la connessione, non si chiamano questi strumenti. Porre una domanda in linguaggio naturale al client AI compatibile con MCP, ad esempio ChatGPT, Claude o Cursore. Il client seleziona gli strumenti per l'operazione.

Ad esempio, quando si chiede "Quali sono stati i primi 10 account per reddito nell'anno fiscale precedente?", il client AI esamina lo schema della serie di dati, genera il linguaggio di query di Salesforce Analytics (SAQL) e restituisce risultati strutturati con execute_query.

Un tipico flusso di lavoro di query è list_datasets a get_dataset (acquisisci currentVersionId) a get_xmd (nomi di campi esatti) a execute_query.

La colonna Descrizione / Input indica i parametri obbligatori. Gli altri parametri sono facoltativi.

Strumenti di organizzazione e individuazione

I client di intelligenza artificiale compatibili con MCP esterni utilizzano questi strumenti per trovare cartelle (app) che contengono cruscotti digitali, serie di dati e lenti e per caricare i metadati completi delle cartelle.

Nome strumento Descrizione / Input Restituisce Usa quando
list_folders

Restituisce le cartelle (app) a cui l'utente connesso può accedere.

Input: q (termini di ricerca; lo strumento aggiunge un carattere jolly all'ultimo token), scope (CreatedByMe, Mru, SharedWithMe), sort (Name, Mru, LastModified, LastModifiedBy), isPinned, pageSize (1–200, valore predefinito 25), page.

Oggetti cartella con ID, etichetta, descrizione, origine del modello e autorizzazioni. Sono necessari ID cartella per circoscrivere le chiamate elenco successive o si desidera un inventario delle app.
get_folder

Restituisce metadati completi per una cartella (app).

Input: folderId (obbligatorio). Scoprire gli ID con list_folders.

Oggetto cartella con etichetta, descrizione, origine del modello e autorizzazioni. Sono necessari metadati completi per un'app specifica.

Strumenti dati e schema

I client AI esterni compatibili con MCP utilizzano questi strumenti per elencare le serie di dati e recuperare i nomi dei campi, i tipi di dati e le etichette necessari per generare SAQL valido.

Nome strumento Descrizione / Input Restituisce Usa quando
list_datasets

Restituisce le serie di dati in un'app o in tutta l'organizzazione.

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

Oggetti serie di dati con nomi, tipi e date dell'ultima modifica. Sono necessari i nomi e gli ID delle serie di dati prima di esaminare uno schema o eseguire una query.
get_dataset

Restituisce i metadati completi di una serie di dati, incluse le informazioni sulla versione corrente.

Input: datasetIdOrApiName (obbligatorio).

Metadati delle serie di dati, inclusi nomi di campi, tipi di dati, etichette di dimensioni e misure e ID versione corrente. Hai bisogno di currentVersionId prima di chiamare get_xmd o execute_query.
get_xmd

Restituisce metadati estesi (XMD) per una versione della serie di dati, inclusi nomi API dei campi esatti, tipi di dati, etichette e formattazione.

Input: datasetIdOrApiName (obbligatorio), versionId (obbligatorio; ID di 18 caratteri che inizia con 0Fc da get_dataset), xmdType (impostazione predefinita main, pronto per la query; system; user).

Metadati estesi per la versione della serie di dati, inclusi nomi API dei campi, tipi di dati, etichette e formattazione della visualizzazione. Sono necessari nomi API di campo precisi in modo che il client possa creare SAQL sintatticamente corretto.

Strumenti di query e analisi

I client di intelligenza artificiale compatibili con MCP esterni utilizzano questo strumento per eseguire SAQL su una serie di dati CRM Analytics e restituire risultati strutturati. Il client genera SAQL dalla richiesta in linguaggio naturale.

Nome strumento Descrizione / Input Restituisce Usa quando
execute_query

Esegue una query SAQL su una serie di dati CRM Analytics.

Input: query (obbligatorio; pipeline SAQL; fase di caricamento deve utilizzare "<datasetId>/<currentVersionId>"; terminare con q = limit q N;), queryLanguage (bloccato su Saql), timezone (fuso orario in formato IANA, ad esempio America/Los_Angeles), version (versione SAQL; ometti per l'ultima versione).

Risultati delle query JSON strutturate con righe, metadati delle colonne e dettagli dell'esecuzione delle query. Si desidera raggruppare, filtrare o classificare le risposte da una serie di dati. Non utilizzare questo strumento per l'individuazione dei metadati.

Cruscotti digitali, strumenti di visualizzazione ed esplorazione

I client AI esterni compatibili con MCP utilizzano questi strumenti per trovare i cruscotti digitali e le esplorazioni salvate (lenti) e per recuperare definizioni di widget, fasi, filtri e query.

Nome strumento Descrizione / Input Restituisce Usa quando
list_dashboards

Restituisce i cruscotti digitali CRM Analytics in un'app o in tutta l'organizzazione.

Input: q, folderId, type (impostazione predefinita Dashboard; anche DashboardSnapshot, Component: il componente richiede l'accesso in modifica e non può restituire risultati per gli utenti di sola visualizzazione), templateApiName, mobileOnly, ids, scope, sort, pageSize (1–200, impostazione predefinita 25), page.

Oggetti dei cruscotti digitali con nomi, ID, tipi e contesto dell'app. Sono necessari gli identificativi dei cruscotti digitali o si desidera sfogliare i cruscotti digitali predefiniti per un'app.
get_dashboard

Restituisce metadati completi per un cruscotto digitale, inclusi widget, fasi e filtri.

Input: dashboardIdOrApiName (obbligatorio).

Metadati completi del cruscotto digitale, inclusi widget, fasi, configurazioni dei filtri e dettagli del layout. È necessaria la definizione completa di un cruscotto digitale specifico.
list_lenses

Restituisce le esplorazioni salvate (lenti) a cui l'utente connesso può accedere.

Input: q, folderId, scope, sort, pageSize (1–200, default 25), page.

Oggetti lente con nomi, ID e serie di dati a cui fanno riferimento. È necessario un inventario delle esplorazioni salvate e delle serie di dati utilizzate.
get_lens

Restituisce metadati completi per una lente, inclusi la definizione della query e il riferimento alla serie di dati.

Input: lensIdOrApiName (obbligatorio).

Metadati della lente completa, inclusi la definizione della query, la configurazione della visualizzazione e il riferimento alla serie di dati. Sono necessari i dettagli di query e visualizzazione di una lente specifica.
 
Caricamento
Salesforce Help | Article