article
README
🚀 Agentforce代理服务器指南
Agentforce代理服务器指南旨在帮助用户完成环境变量配置、GitHub推送脚本使用、Salesforce相关信息获取等操作,以顺利部署和使用代理服务器。
🚀 快速开始
环境准备
- 操作系统:Linux/MacOS/Windows(推荐使用Linux或 MacOS)
- Java版本:JDK 8 或更高版本
- Git工具:建议安装Git for Windows(若在Windows上)
下载源码
git clone https://github.com/agentforce/server.git
cd server
配置环境变量
编辑~/.bash_profile文件,添加以下内容:
export AGENTFORCE_HOME=$(pwd)
source ~/.bash_profile
依赖安装
进入项目目录后运行:
mvn clean install
启动服务器
cd $AGENTFORCE_HOME/bin
./start.sh
停止服务器
cd $AGENTFORCE_HOME/bin
./stop.sh
✨ 主要特性
- 提供环境变量配置和GitHub推送脚本,简化操作流程。
- 自动管理消息交换的序列号,维护每个电子邮件地址的身份验证和会话状态。
- 记录所有API交互,方便调试。
📦 安装指南
环境变量配置
要配置环境变量,请按照以下步骤操作:
- 打开终端
- 运行命令:
source ~/.bash_profile
下载与依赖安装
- 下载源码:
git clone https://github.com/agentforce/server.git
cd server
- 配置环境变量:
编辑
~/.bash_profile文件,添加以下内容:
export AGENTFORCE_HOME=$(pwd)
source ~/.bash_profile
- 依赖安装:
mvn clean install
💻 使用示例
基础用法
使用github_push.sh脚本
该脚本帮助将本地仓库推送到GitHub,特别适合新项目初始化。
- 将脚本添加到项目根目录:
wget https://raw.githubusercontent.com/agentforce/server/master/bin/github_push.sh
- 赋予执行权限并运行:
chmod +x github_push.sh
./github_push.sh
按照提示输入GitHub仓库URL后,脚本会自动处理其余步骤。
高级用法
配置文件路径示例
# 设置代理服务器路径
export AGENTFORCE_HOME=/path/to/agentforce-server
# 设置运行环境
export ENV=development
# 启动服务器
$AGENTFORCE_HOME/bin/start.sh
📚 详细文档
创建Connected App
- 使用管理员账户登录Salesforce组织
- 进入设置
- 在快速搜索栏中输入"App Manager"并点击进入
- 点击新建连接应用
- 填写基本信息:
- 应用程序名称:例如 "Agentforce MCP集成"
- API名称:将自动填充
- 联系邮箱:填写您的邮箱地址
- 启用OAuth设置选项
- 设置回调URL为
https://localhost/oauth/callback - 在选择的OAuth范围中,添加:
- 管理用户数据(api)
- 任何时间执行请求(refresh_token, offline_access)
- 点击保存
- 在连接应用详情页面记录消费者密钥(Client ID)
- 点击显示旁边的消费者秘密(Consumer Secret)以获取客户端密码
获取代理ID
- 登录Salesforce组织
- 导航至Einstein Agent Builder
- 选择要使用的代理
- 查看浏览器地址栏中的URL,格式为
https://your-salesforce-instance.lightning.force.com/lightning/r/Agent__c/0XxXXXXXXXXXXXXX/view - 提取18位字符ID(如
0XxXXXXXXXXXXXXX)作为代理ID
获取Salesforce My Domain URL
- 登录Salesforce组织
- 进入设置
- 在快速搜索栏中输入"My Domain"并点击进入
- 查看显示的域名格式为
DOMAIN-NAME.my.salesforce.com - 将此URL(不带"https://”前缀)用于
.env文件
获取组织ID
- 登录Salesforce组织
- 进入设置
- 在快速搜索栏中输入"公司信息"并点击进入
- 查看"组织ID"字段,这是您的 Salesforce 组织ID
- 它将是一个15或18位的字符编码
🔧 技术细节
服务器管理
- 服务器自动管理消息交换的序列号。
- 每个电子邮件地址维护身份验证和会话状态。
- 所有API交互都会记录以备调试使用。
GitHub推送脚本
该脚本将执行以下操作:
- 检查系统是否已安装Git
- 确保敏感文件(如
.env)不会被推送到GitHub(这些文件已添加到.gitignore) - 提示用户输入GitHub仓库URL
- 初始化Git仓库或更新远程仓库URL
- 显示要提交的文件供用户确认
- 自动生成提交消息并推送更改
📄 许可证
文档中未提及相关许可证信息。
⚠️ 注意事项
- 服务器自动管理消息交换的序列号。
- 每个电子邮件地址维护身份验证和会话状态。
- 所有API交互都会记录以备调试使用。
💡 使用建议
故障排除
遇到问题时,请检查以下内容:
- 认证失败:确认连接应用设置无误。
- 代理ID获取错误:检查Einstein Agent Builder中的URL。
- 组织ID错误:在公司信息页面核对。
- 回调URL问题:确保设置了正确的本地回拨地址。
常见问题解答
Q: 如何处理SSH连接问题?
A: 确保本地已生成SSH密钥,并添加到GitHub的SSH Keys设置中。运行以下命令测试:
ssh -T git@github.com
Q: 推送失败怎么办?
A: 检查网络连接,确认仓库URL正确,然后重新运行脚本。
完整示例
# 下载源码
git clone https://github.com/agentforce/server.git
cd server
# 配置环境变量
echo 'export AGENTFORCE_HOME=$(pwd)' >> ~/.bash_profile
source ~/.bash_profile
# 安装依赖
mvn clean install
# 启动服务器
cd $AGENTFORCE_HOME/bin
./start.sh
运行以上命令后,您将成功部署并启动Agentforce代理服务器。
微信扫一扫