Loading
CRM Analytics (CRM-analyser)
CRM Analytics MCP-serverværktøjsreference

breadcrumbDescription

  1. helpHomeLinkText
  2. docsHomeLinkTextShort
  3. CRM Analytics (CRM-analyser)

CRM Analytics MCP-serverværktøjsreference

Skrivebeskyttede værktøjer, der gør det muligt for MCP-kompatible AI-klienter at opdage apps, undersøge skemaer, køre SAQL-forespørgsler og læse dashboard- og linsemetadata.

EditionsHeading

Tilgængelig i Lightning Experience
Tilgængelig med CRM Analytics, som er tilgængelig for en merpris i Enterprise, Performance og Unlimited Edition.

Når du har oprettet forbindelse, kalder du ikke disse værktøjer selv. Stil din MCP-kompatible AI-klient, f.eks. ChatGPT, Claude eller Cursor, et spørgsmål på naturligt sprog. Klienten vælger værktøjerne til opgaven.

Når du f.eks. spørger "Hvad var vores top 10-konti efter omsætning sidste regnskabsår?" undersøger AI-klienten datasætskemaet, genererer SAQL (Salesforce Analytics Query Language) og returnerer strukturerede resultater med execute_query.

Et typisk forespørgselsarbejdsflow er list_datasets til get_dataset (registrer currentVersionId) til get_xmd (eksakt feltnavne) til execute_query.

Kolonnen Beskrivelse/Input noterer påkrævede parametre. Andre parametre er valgfri.

Organisations- og Discovery-værktøjer

Eksterne MCP-kompatible AI-klienter bruger disse værktøjer til at finde mapper (apps), der indeholder dashboards, datasæt og linser, og til at indlæse fulde mappemetadata.

Værktøjsnavn Beskrivelse/input Returnerer Brug når
list_folders

Returnerer mapper (apps), som den tilsluttede bruger kan få adgang til.

Input: q (seudtryk; værktøjet føjer et jokertegn til det sidste token), scope (CreatedByMe, Mru, SharedWithMe), sort (Name, Mru, LastModified, LastModifiedBy), isPinned, pageSize (1-200, standard 25), page.

 Mappeobjekter med id, betegnelse, beskrivelse, skabelonkilde og tilladelser. Du skal have mappe-id'er for at håndtere senere listeopkald, eller du ønsker en opgørelse over apps.
get_folder

Returnerer fulde metadata for en mappe (app).

Input: folderId (påkrævet). Opdag id'er med list_folders.

 Et mappeobjekt med betegnelse, beskrivelse, skabelonkilde og tilladelser. Du skal have komplette metadata for en bestemt app.

Data- og skemaværktøjer

Eksterne MCP-kompatible AI-klienter bruger disse værktøjer til at angive datasæt og hente de feltnavne, datatyper og betegnelser, der er påkrævet for at generere gyldig SAQL.

Værktøjsnavn Beskrivelse/input Returnerer Brug når
list_datasets

Returnerer datasæt i en app eller på tværs af organisationen.

Inputs: 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.

 Datasætobjekter med navne, typer og senest ændrede datoer. Du skal have datasætnavne og id'er, før du undersøger et skema eller kører en forespørgsel.
get_dataset

Returnerer fulde metadata for et datasæt, herunder oplysninger om den aktuelle version.

Input: datasetIdOrApiName (påkrævet).

 Datasætmetadata, herunder feltnavne, datatyper, dimensions- og målbetegnelser og aktuelt versions-id. Du skal bruge currentVersionId, før du ringer til get_xmd eller execute_query.
get_xmd

Returnerer udvidede metadata (XMD) for en datasætversion, herunder nøjagtige API-feltnavne, datatyper, betegnelser og formatering.

Input: datasetIdOrApiName (påkrævet), versionId (påkrævet; 18-tegns id, der starter med 0Fc fra get_dataset), xmdType (main standard, forespørgsel klar; system; user).

 Udvidede metadata for datasætversionen, herunder API-feltnavne, datatyper, betegnelser og visningsformatering. Du skal have præcise API-feltnavne, så klienten kan opbygge syntaktisk korrekt SAQL.

Forespørgsels- og analyseværktøjer

Eksterne MCP-kompatible AI-klienter bruger dette værktøj til at køre SAQL op mod et CRM Analytics-datasæt og returnere strukturerede resultater. Klienten genererer SAQL fra din anmodning på naturligt sprog.

Værktøjsnavn Beskrivelse/input Returnerer Brug når
execute_query

Kører en SAQL-forespørgsel op mod et CRM Analytics-datasæt.

Input: query (påkrævet; SAQL-pipeline; indlæsningsfasen skal bruge "<datasetId>/<currentVersionId>"; slut med q = limit q N;), queryLanguage (låst til Saql), timezone (tidszone i IANA-format, f.eks. America/Los_Angeles), version (SAQL-version; udelad for senest).

 Strukturerede JSON-forespørgselsresultater med rækker, kolonnemetadata og detaljer for forespørgselsudførelse. Du ønsker grupperede, filtrerede eller rangerede svar fra et datasæt. Brug ikke dette værktøj til metadataopdagelse.

Dashboard-, visualiserings- og udforskningsværktøjer

Eksterne MCP-kompatible AI-klienter bruger disse værktøjer til at finde dashboards og gemte udforskninger (linser) og til at hente widget-, trin-, filter- og forespørgselsdefinitioner.

Værktøjsnavn Beskrivelse/input Returnerer Brug når
list_dashboards

Returnerer CRM Analytics-dashboards i en app eller på tværs af organisationen.

Inputs: q, folderId, type (standarden er Dashboard; også DashboardSnapshot, Component – Komponent kræver redigeringsadgang og kan ikke returnere nogen resultater for kun visningsbrugere), templateApiName, mobileOnly, ids, scope, sort, pageSize (1–200, standard 25), page.

 Dashboardobjekter med navne, id'er, typer og appkontekst. Du skal bruge dashboard-id'er, eller du ønsker at gennemse dashboards, der er bygget på forhånd, for en app.
get_dashboard

Returnerer fulde metadata for et dashboard, herunder widgets, trin og filtre.

Input: dashboardIdOrApiName (påkrævet).

 Fuldstændige dashboardmetadata inklusive widgets, trin, filterkonfigurationer og layoutdetaljer. Du skal have den fulde definition af et specifikt dashboard.
list_lenses

Returnerer gemte udforskninger (linser), som den tilsluttede bruger kan få adgang til.

Indgange: q, folderId, scope, sort, pageSize (1-200, standard 25), page.

 Linseobjekter med navne, id'er og de datasæt, de refererer til. Du skal have en opgørelse over gemte udforskninger og de datasæt, de bruger.
get_lens

Returnerer fulde metadata for en linse, herunder forespørgselsdefinitionen og datasætreferencen.

Input: lensIdOrApiName (påkrævet).

 Fuld linse-metadata inklusive forespørgselsdefinition, visualiseringskonfiguration og datasætreference. Du skal bruge forespørgsels- og visualiseringsdetaljer for en bestemt linse.
 
Indlæser
Salesforce Help | Article