Loading
CRM Analytics
Referanse for CRM Analytics MCP Server Tool

Du er her:

  1. Salesforce Hjelp
  2. Dokumenter
  3. CRM Analytics

Referanse for CRM Analytics MCP Server Tool

Skrivebeskyttede verktøy som lar MCP-kompatible AI-klienter oppdage apper, inspisere skjemaer, kjøre SAQL-spørringer og lese kontrollpanel- og linsemetadata.

Nødvendige utgaver

Tilgjengelig i Lightning Experience
Tilgjengelig med CRM Analytics, som er tilgjengelig for en ekstra kostnad i Enterprise, Performance og Unlimited Edition.

Når du har koblet til, kaller du ikke opp disse verktøyene selv. Still din MCP-kompatible AI-klient, som ChatGPT, Claude eller Markør, et spørsmål på naturlig språk. Klienten velger verktøyene for oppgaven.

Når du for eksempel spør "Hva var våre 10 beste kontoer etter omsetning forrige regnskapsår?", inspiserer AI-klienten datasettskjemaet, genererer Salesforce Analytics Query Language (SAQL) og returnerer strukturerte resultater med execute_query.

En typisk spørringsarbeidsflyt er list_datasets til get_dataset (fang currentVersionId) til get_xmd (eksakt feltnavn) til execute_query.

Kolonnen Beskrivelse / inndata noterer seg nødvendige parametere. Andre parametere er valgfrie.

Organisasjons- og oppdagelsesverktøy

Eksterne MCP-kompatible AI-klienter bruker disse verktøyene til å finne mapper (apper) som inneholder kontrollpaneler, datasett og linser, og til å laste inn fullstendige mappemetadata.

Navn på verktøy Beskrivelse / inndata Returer Brukes når
list_folders

Returnerer mapper (apper) som den tilkoblede brukeren har tilgang til.

Inndata: q (søkeord; verktøyet føyer til et jokertegn til det siste tokenet), scope (CreatedByMe, Mru, SharedWithMe), sort (Name, Mru, LastModified, LastModifiedBy), isPinned, pageSize (1–200, standard 25), page.

 Mappeobjekter med ID, etikett, beskrivelse, malkilde og tillatelser. Du trenger mappe-IDer for å omfatte senere listekall, eller du vil ha en oversikt over apper.
get_folder

Returnerer fullstendige metadata for én mappe (app).

Inndata: folderId (obligatorisk). Oppdag IDer med list_folders.

 Et mappeobjekt med etikett, beskrivelse, malkilde og tillatelser. Du trenger fullstendige metadata for en bestemt app.

Data- og skjemaverktøy

Eksterne MCP-kompatible AI-klienter bruker disse verktøyene til å vise datasett og hente feltnavn, datatyper og etiketter som kreves for å generere gyldig SAQL.

Navn på verktøy Beskrivelse / inndata Returer Brukes når
list_datasets

Returnerer datasett i en app eller på tvers av organisasjonen.

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

 Datasettobjekter med navn, typer og datoer som sist ble endret. Du trenger datasettnavn og -ID-er før du inspiserer et skjema eller kjører en spørring.
get_dataset

Returnerer fullstendige metadata for et datasett, inkludert informasjon om gjeldende versjon.

Inndata: datasetIdOrApiName (obligatorisk).

 Datasettmetadata, inkludert feltnavn, datatyper, dimensjons- og målingsetiketter og gjeldende versjons-ID. Du trenger currentVersionId før du ringer get_xmd eller execute_query.
get_xmd

Returnerer utvidede metadata (XMD) for en datasettversjon, inkludert eksakte API-navn for felt, datatyper, etiketter og formatering.

Inndata: datasetIdOrApiName (obligatorisk), versionId (obligatorisk; 18-tegns ID som starter med 0Fc fra get_dataset), xmdType (main standard, spørringsklar; system; user).

 Utvidede metadata for datasettversjonen, inkludert API-navn på felt, datatyper, etiketter og visningsformatering. Du trenger presise API-navn for felt slik at klienten kan bygge syntaksmessig riktig SAQL.

Spørrings- og analyseverktøy

Eksterne MCP-kompatible AI-klienter bruker dette verktøyet til å kjøre SAQL mot et CRM Analytics-datasett og returnere strukturerte resultater. Klienten genererer SAQL fra forespørselen med naturlig språk.

Navn på verktøy Beskrivelse / inndata Returer Brukes når
execute_query

Utfører en SAQL-spørring mot et CRM Analytics-datasett.

Inndata: query (nødvendig; SAQL pipeline; lastfasen må bruke "<datasetId>/<currentVersionId>"; slutter med q = limit q N;), queryLanguage (låst til Saql), timezone (tidssone i IANA-format, for eksempel America/Los_Angeles), version (SAQL-versjon; utelate for siste).

 Strukturerte JSON-spørringsresultater med rader, kolonnemetadata og detaljer om utførelse av spørringer. Du vil ha grupperte, filtrerte eller rangerte svar fra et datasett. Ikke bruk dette verktøyet til oppdagelse av metadata.

Kontrollpanel-, visualiserings- og utforskingsverktøy

Eksterne MCP-kompatible AI-klienter bruker disse verktøyene til å finne kontrollpaneler og lagrede utforskinger (linser) og til å hente widget-, trinn-, filter- og spørringsdefinisjoner.

Navn på verktøy Beskrivelse / inndata Returer Brukes når
list_dashboards

Returnerer CRM Analytics-kontrollpaneler i en app eller på tvers av organisasjonen.

Inndata: q, folderId, type (standard til Dashboard; også DashboardSnapshot, Component – Komponent krever redigeringstilgang og kan ikke returnere noen resultater for brukere som bare viser), templateApiName, mobileOnly, ids, scope, sort, pageSize (1–200, standard 25), page.

 Kontrollpanelobjekter med navn, ID-er, typer og appkontekst. Du trenger kontrollpanelidentifikatorer eller vil bla gjennom forhåndsbygde kontrollpaneler for en app.
get_dashboard

Returnerer fullstendige metadata for ett kontrollpanel, inkludert widgeter, trinn og filtre.

Inndata: dashboardIdOrApiName (obligatorisk).

 Fullstendige kontrollpanelmetadata, inkludert widgeter, trinn, filterkonfigurasjoner og oppsettdetaljer. Du trenger den fullstendige definisjonen av et bestemt kontrollpanel.
list_lenses

Returnerer lagrede utforskinger (linser) som den tilkoblede brukeren har tilgang til.

Inndata: q, folderId, scope, sort, pageSize (1–200, standard 25), page.

 Linseobjekter med navn, ID-er og datasettene de refererer til. Du trenger en oversikt over lagrede utforskinger og datasettene de bruker.
get_lens

Returnerer fullstendige metadata for én linse, inkludert spørringsdefinisjonen og datasettreferansen.

Inndata: lensIdOrApiName (obligatorisk).

 Full linsemetadata, inkludert spørringsdefinisjonen, visualiseringskonfigurasjonen og datasettreferansen. Du trenger spørrings- og visualiseringsdetaljene for en bestemt linse.
 
Laster
Salesforce Help | Article