Loading
CRM Analytics
CRM Analytics MCP 服务器工具参考

CRM Analytics MCP 服务器工具参考

只读工具,允许符合 MCP 的 AI 客户端发现应用程序、检查模式、运行 SAQL 查询以及读取仪表板和镜头元数据。

所需的 Edition

适用于 Lightning Experience。
适用于 CRM Analytics,另行付费后适用于 Enterprise、Performance 和 Unlimited Edition。

在您连接后,您无需自行调用这些工具。使用自然语言向您的符合 MCP 的 AI 客户端提问,例如 ChatGPT、Claude 或 Cursor。客户端选择任务的工具。

例如,当您询问“上个会计年度按收入划分的前 10 个客户是什么?”时,AI 客户端会检查数据集模式,生成 Salesforce Analytics 查询语言 (SAQL),并使用execute_query返回结构化结果。

典型的查询工作流是list_datasets到get_dataset(捕获currentVersionId)到get_xmd(精确字段名称)到execute_query。

“描述/输入”列会备注必填参数。其他参数是可选的。

组织和发现工具

符合外部 MCP 的 AI 客户端使用这些工具查找包含仪表板、数据集和镜头的文件夹(应用程序),并加载完整的文件夹元数据。

工具名称 描述/输入 返回 使用时间
list_folders

返回连接用户可以访问的文件夹(应用程序)。

输入:q(搜索词;工具将通配符附加到最后一个标记)、scope(CreatedByMe、Mru、SharedWithMe)、sort(Name、Mru、LastModified、LastModifiedBy)、isPinned、pageSize(1-200,默认为 25)、page。

具有 ID、标签、描述、模板源和权限的文件夹对象。 您需要文件夹 ID 来确定稍后列表调用的范围,或者您需要应用程序清单。
get_folder

返回一个文件夹(应用程序)的完整元数据。

输入:folderId(必填)。使用list_folders发现 ID。

带有标签、描述、模板源和权限的文件夹对象。 您需要特定应用程序的完整元数据。

数据和模式工具

符合 MCP 的外部 AI 客户端使用这些工具列出数据集,并检索生成有效 SAQL 所需的字段名称、数据类型和标签。

工具名称 描述/输入 返回 使用时间
list_datasets

返回应用程序中或整个组织的数据集。

输入: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,默认为 25)、page。

包含名称、类型和上次修改日期的数据集对象。 在检查模式或运行查询之前,您需要数据集名称和 ID。
get_dataset

返回数据集的完整元数据,包括当前版本信息。

输入:datasetIdOrApiName(必填)。

数据集元数据,包括字段名称、数据类型、维度和评测标签以及当前版本 ID。 在致电get_xmd或execute_query前,您需要currentVersionId。
get_xmd

返回数据集版本的扩展元数据 (XMD),包括精确的字段 API 名称、数据类型、标签和格式。

输入:datasetIdOrApiName(必填)、versionId(必填;以 get_dataset 0Fc 开头的 18 个字符的 ID)、xmdType(main 默认值、查询就绪;system;user)。

数据集版本的扩展元数据,包括字段 API 名称、数据类型、标签和显示格式。 您需要精确的字段 API 名称,以便客户端可以构建语法正确的 SAQL。

查询和分析工具

符合外部 MCP 的 AI 客户端使用此工具针对 CRM Analytics 数据集运行 SAQL,并返回结构化结果。客户端从您的自然语言请求生成 SAQL。

工具名称 描述/输入 返回 使用时间
execute_query

对 CRM Analytics 数据集执行 SAQL 查询。

输入:query(必填;SAQL 漏斗;加载阶段必须使用 "<datasetId>/<currentVersionId>";以 q = limit q N; 结尾)、queryLanguage(锁定到 Saql)、timezone(以 IANA 格式表示的时区,例如 America/Los_Angeles)、version(SAQL 版本;省略为最新)。

包含行、列元数据和查询执行详细信息的结构化 JSON 查询结果。 您想要从数据集中分组、筛选或排名答案。请勿将此工具用于元数据发现。

仪表板、可视化和探索工具

符合外部 MCP 的 AI 客户端使用这些工具来查找仪表板和保存的探索(镜头),并检索小部件、步骤、筛选器和查询定义。

工具名称 描述/输入 返回 使用时间
list_dashboards

在应用程序或整个组织中返回 CRM Analytics 仪表板。

输入:q、folderId、type(默认为 Dashboard;也是 DashboardSnapshot、Component—组件需要编辑访问权限,并且不能为仅查看用户返回任何结果)、templateApiName、mobileOnly、ids、scope、sort、pageSize(1–200,默认为 25)、page。

包含名称、ID、类型和应用程序上下文的仪表板对象。 您需要仪表板标识符,或想要浏览应用程序的预构建仪表板。
get_dashboard

返回一个仪表板的完整元数据,包括小部件、步骤和筛选器。

输入:dashboardIdOrApiName(必填)。

完整的仪表板元数据,包括小部件、步骤、筛选器配置和布局详细信息。 您需要特定仪表板的完整定义。
list_lenses

返回连接的用户可以访问的已保存探索(镜头)。

输入:q、folderId、scope、sort、pageSize(1–200,默认为 25)、page。

包含名称、ID 及其引用数据集的镜头对象。 您需要保存的探索及其使用的数据集的清单。
get_lens

返回一个镜头的完整元数据,包括查询定义和数据集引用。

输入:lensIdOrApiName(必填)。

完整镜头元数据,包括查询定义、可视化配置和数据集引用。 您需要特定镜头的查询和可视化详细信息。
 
正在加载
Salesforce Help | Article