salesforcedatadictionary

Salesforce数据字典

用于描述和管理Salesforce对象的模型上下文协议（MCP）服务器。此MCP提供了用于从Salesforce对象中列出、描述和创建数据字典的工具，使探索和记录Salesforce模式变得容易。

特性

• 描述Salesforce对象：获取任何Salesforce对象的详细字段信息
• 列出所有对象：浏览所有可用的Salesforce对象
• 查找相似对象：搜索名称相似的对象
• CSV/Excel导出：导出字段信息；Excel导出支持多个对象（每个对象一张表）
• 数据字典创建：将Salesforce对象转换为数据字典
• 智能物体检测：如果未找到完全匹配，则自动查找相似对象

先决条件

• Salesforce命令行界面：必须安装并验证
• Node.js：版本16或更高
• npm：用于包管理

安装Salesforce CLI

npm install -g @salesforce/cli
sf login org

安装

您可以从repo本地运行此MCP（构建然后将Cursor指向 dist/index.js)或直接通过 npx 没有克隆。

选项A：使用npx（推荐）

将此添加到 ~/.cursor/mcp_servers.json:

{
  "mcpServers": {
    "salesforce-data-dictionary": {
      "command": "npx",
      "args": ["-y", "salesforce-data-dictionary"],
      "env": {}
    }
  }
}

• npx -y salesforce-data-dictionary 将获取并运行最新发布的版本。
• 无需本地结账。

选项B：本地结账

1. 克隆和构建：

git clone 
cd salesforceDataDictionary
npm install
npm run build

1. 配置Cursor以运行构建的入口点：

{
  "mcpServers": {
    "salesforce-data-dictionary": {
      "command": "node",
      "args": ["/Users/ffarath/Documents/projects/salesforceDataDictionary/dist/index.js"],
      "env": {}
    }
  }
}

1. 重新启动游标。

可用工具

1. Describe Salesforce Object

描述Salesforce对象并以CSV格式返回其字段信息。

参数：

• objectName （string）：要描述的Salesforce对象的名称（例如，Account、Contact、CustomObject\_\_c）
• outputFile （字符串，可选）：保存CSV输出的文件名（例如“account_fields.CSV”）

例子：

Describe the Account object and save the results to account_fields.csv

2. List Salesforce Objects

列出所有可用的Salesforce对象。

参数：

• searchTerm （字符串，可选）：用于筛选对象的搜索词

例子：

List all Salesforce objects that contain "user" in the name

3. Find Similar Objects

查找具有相似名称的Salesforce对象。

参数：

• searchTerm （string）：查找相似对象名称的搜索词

例子：

Find objects similar to "Account"

4. Create Data Dictionary

从一个或多个Salesforce对象创建Excel数据字典（每个标记有对象标签的对象有一个选项卡）。

参数：

• objects （string）：以逗号分隔的Salesforce对象列表（例如，“帐户、联系人、机会”）。您还可以通过以下方式之一： ALL, all objects, whole org, * 包含由返回的每个对象 sf sobject list --sobject all.
• outputFile （字符串）：Excel文件名（例如，“data_dictionary.xlsx”）

例子：

Create a data dictionary for Account, Contact, Opportunity and save to data_dictionary.xlsx

您还可以为整个组织生成词典：

Create a data dictionary for ALL and save to full_org_dictionary.xlsx

示例用法

描述Salesforce对象

Describe the Account object and show me all its fields in CSV format

MCP将：

1. 使用列出所有Salesforce对象 sf sobject list --sobject all
2. 检查“帐户”是否存在
3. 如果发现，请使用 sf sobject describe --sobject Account
4. 解析JSON响应并将其显示为用户友好的CSV

创建Excel数据字典

Create a data dictionary from "Account, Contact, Opportunity" and save to sales_schema.xlsx

这将生成一个Excel，其中包含三张根据每个对象标签命名的工作表。

CSV/Excel输出格式

列包括：

• 字段名称
• 类型
• 标签
• 描述
• 必需
• 独特
• 长度
• 精确度
• 规模
• 默认值
• 选择列表值
• 参考
• 关系名称

错误处理

• 找不到对象：如果找不到确切的对象名称，它会提示类似的对象
• Salesforce CLI错误：清除身份验证或连接问题的错误消息
• 对象名称无效：常见命名模式的有用建议

Salesforce CLI集成

此MCP依赖Salesforce CLI进行所有操作：

• sf sobject list --sobject all：列出所有可用对象
• sf sobject describe --sobject ：描述特定对象

确保您已通过正确的Salesforce组织的身份验证：

sf login org
sf org list

支持的Salesforce对象

• 标准对象（客户、联系人、潜在客户、机会等）
• 自定义对象（CustomObject\_\_c）
• 系统对象
• 外部对象

许可证

MIT许可证-有关详细信息，请参阅许可证文件。

salesforce数据字典