README
🚀 Salesforce MCP 服务器
这是一个基于 Salesforce MCP 协议的工具,它能与 Salesforce 集成,借助自然语言处理技术,实现对 Salesforce 中对象和记录的查询、修改与管理,有效简化了与 Salesforce 的交互流程。
🚀 快速开始
此工具能通过自然语言处理技术,让你方便地与 Salesforce 进行交互,轻松完成对象和记录的查询、修改与管理。
✨ 主要特性
- 基于 Salesforce MCP 协议实现,可与 Salesforce 无缝集成。
- 利用自然语言处理技术,简化与 Salesforce 的交互流程。
📦 安装指南
使用以下命令通过 npm 安装该包:
# 使用 npm 安装包
npm install salesforce-mcp-server
💻 使用示例
基础用法
以下是一些基本的使用示例:
// 搜索对象
server.searchObjects("Account");
// 获取模式信息
server.getSchemaInfo("Account", "fields");
// 查询记录
server.queryRecords("SELECT Id, Name FROM Account WHERE CreatedDate = TODAY()");
📚 详细文档
设置
身份验证方式
- 用户名/密码认证:需要配置以下环境变量:
SALESFORCE_USERNAME:Salesforce 用户名或电子邮件。SALESFORCE_PASSWORD:Salesforce 密码。SALESFORCE_SECURITY_TOKEN:Salesforce 安全令牌。
- OAuth2 认证:需要配置以下环境变量:
SALESFORCE_CLIENT_ID:注册应用时获取的客户端 ID。SALESFORCE_CLIENT_SECRET:应用的密钥。SALESFORCE_REDIRECT_URI:重定向 URI。
在 Cursor IDE 中集成
- 打开 Cursor IDE 的设置。
- 导航到插件管理或扩展部分。
- 搜索并安装 Salesforce MCP 插件。
- 配置插件,输入相关环境变量。
在 Claude Desktop 中集成
- 将配置文件
config.json放置在相应的位置:- Windows:
%APPDATA%\Claude Desktop\config.json - macOS:
~/Library/Application Support/Claude Desktop/config.json
- Windows:
- 确保配置文件包含以下内容:
{ "salesforce": { "username": "your_salesforce_username", "password": "your_salesforce_password", "security_token": "your_security_token" } }
开发
从源代码构建
# 克隆仓库
git clone git@github.com:yourusername/salesforce-mcp-server.git
# 进入目录
cd salesforce-mcp-server
# 安装依赖项
npm install
# 构建项目
npm run build
故障排除
- 身份验证错误
- 确认凭据是否正确。
- 对于用户名密码认证,确保安全令牌有效。
- 对于 OAuth2 认证,检查客户端 ID 和密钥是否正确。
- 连接问题
- 检查 Salesforce 实例 URL 是否正确。
- 确保网络连接正常。
- 验证 API 访问权限。
- Cursor IDE 集成问题
- 重启 Cursor IDE 后确认插件已加载。
- 使用开发者工具检查控制台输出。
- 确认全局安装了 npm 包。
- Claude Desktop 集成问题
- 检查配置文件位置是否正确。
- 确保文件权限无误。
- 重启 Claude Desktop 后确认插件加载状态。
- 确保环境变量已正确设置。
🤝 贡献
欢迎贡献!请随意提交 Pull Request。
📄 许可证
本项目遵循 MIT 许可证,详细信息请查看 LICENSE 文件。
❓ 问题与支持
如需帮助或报告问题,请在 GitHub 仓库中创建 ISSUE。
Scan to contact