使用说明
Salesforce MCP服务器
该项目提供了一个模型内容协议(MCP)服务器,作为大型语言模型(LLM)和Salesforce API之间的桥梁。它公开了一组工具,允许LLM与Salesforce数据交互,涵盖销售云和服务云功能。
特性
- Salesforce集成:使用用户凭据安全连接到Salesforce实例。
- 工具曝光:展示了一套丰富的工具,用于与Salesforce对象(如联系人、帐户、机会和案例)进行交互。
- 销售云工具:搜索联系人、获取帐户详细信息、列出未完成的机会和记录活动。
- 服务云工具:获取案例详细信息,列出未结案例,创建新案例,并添加评论。
- 全局搜索:跨多个Salesforce对象执行全局搜索。
- 符合MCP标准:基于
mcp.server与MCP兼容客户端无缝集成的框架。
先决条件
要运行此服务器,您需要有效的Salesforce凭据。服务器可以通过环境变量或命令行参数进行配置。
环境变量:
SF_USERNAME:您的Salesforce用户名。SF_PASSWORD:您的Salesforce密码。SF_TOKEN:您的Salesforce安全令牌。SF_DOMAIN:要使用的Salesforce域。默认为login用于生产。使用test沙箱。
安装
-
克隆存储库:
git clone <repository-url> cd salesforce_mcp_server -
安装依赖项: 此项目使用
uv用于包管理。uv pip install -r requirements.txt # Or if you have the pyproject.toml and uv.lock uv sync(注:A
requirements.txt可能需要从以下来源生成pyproject.toml如果不存在)
运行服务器
您可以使用启动服务器 run.py 脚本。您必须将Salesforce凭据作为环境变量(请参阅先决条件)或命令行参数提供。
python run.py --sf-username "your_user@example.com" --sf-password "your_password" --sf-token "your_token"
命令行选项:
--port:运行服务器的端口(默认值:3000).--host:要绑定的主机(默认值:127.0.0.1).--sf-username:Salesforce用户名。--sf-password:Salesforce密码。--sf-token:Salesforce安全令牌。--sf-domain:Salesforce域(默认值:login).--log-level:日志记录级别(例如。,INFO,DEBUG).
可用工具
服务器向LLM公开以下工具:
销售云工具
search_contact:在Salesforce中按姓名和电子邮件(可选)搜索联系人。get_account_details:按客户帐户的确切名称或ID检索其完整详细信息。list_open_opportunities:列出所有尚未完成的销售机会(交易)。可以按帐户或所有者进行筛选。log_activity:记录活动(如电话或电子邮件)并将其与记录(联系人、帐户、机会)相关联。
服务云工具
get_case_details:使用票证编号检索支持票证(案例)的详细信息。list_open_cases:列出所有打开的支持工单,并可选择按联系人电子邮件或帐户名进行筛选。create_case:为客户创建新的支持工单。add_comment_to_case:向现有支持工单添加注释(内部注释或公开回复)。
全球搜索工具
search_salesforce:使用搜索词在Salesforce(客户、联系人、机会、案例)中执行全局搜索。