关键词

AI AgentSalesforce开发LLM集成智能助手Prompt工程

使用说明

项目简介

Salesforce Agentforce SDK 是一个用于在 Salesforce 平台中创建、管理和部署 AI Agent（智能助手）和 Prompt 模板的 Python 开发工具包。它提供了一套编程接口，允许开发者通过 Python 代码定义 AI Agent 的行为和功能，并将其与 Salesforce 数据和服务（如 Apex Action）集成。该 SDK 还包含一个 MCP 服务器组件，用于以标准化的方式向兼容 MCP 的大型语言模型（LLM）客户端提供上下文信息和调用功能。

主要功能点

  • AI Agent 创建与管理： 定义 Agent 的名称、描述、公司信息、示例对话以及其包含的主题（Topic）。
  • 主题与动作（Tools）定义： 在 Agent 中组织相关功能为主题，每个主题包含可供 LLM 调用的具体动作（相当于 MCP 的 Tools），并定义动作的输入和输出参数。
  • Prompt 模板生成与管理： 根据 Salesforce 对象和字段信息，生成与 Salesforce 数据集成的 Prompt 模板，支持模板调优和部署。
  • Salesforce 数据集成： 自动生成 Apex 类，简化与 Salesforce 数据查询和操作的集成。
  • 多种定义格式： 支持使用 JSON 文件、目录结构或直接通过 Python 代码定义 Agent。
  • MCP 服务器： 允许将 Agentforce SDK 的功能作为 MCP 服务暴露给 LLM 客户端，实现上下文信息提供和工具调用。

安装步骤

使用 pip 包管理器进行安装：

pip install agentforce-sdk

如果您需要从源代码安装或进行开发，请参考仓库的 README.md 文档。

服务器配置

本 SDK 包含一个 MCP 服务器的示例实现（位于 'examples/mcp_servers/ai-assist'），该服务器可以将 Agentforce SDK 的功能暴露给 MCP 客户端。

要配置一个兼容 MCP 的 LLM 客户端（例如支持 MCP 协议的 VS Code 扩展）来连接此服务器，您通常需要在客户端的配置文件中添加一个服务器配置项。配置格式通常为 JSON，包含启动服务器进程所需的命令和参数。

以下是一个客户端 MCP 服务器配置的示例结构描述（请勿将此 JSON 块直接复制为代码，这仅是配置结构的说明）：

{
  "servers": [
    {
      "name": "服务器名称", // 给您的服务器配置起一个易于识别的名称，例如 "Agentforce AI Assist Server"
      "command": "用于启动服务器进程的可执行文件路径", // 例如 "python" 或指向您的 Python 环境的路径
      "args": [
        "服务器启动脚本的参数列表" // 例如 ["-m", "ai_assist", "--transport", "stdio"]
        // 参数说明:
        // "-m", "ai_assist": 以模块方式运行 Agentforce SDK 提供的 AI Assist 服务器示例
        // "--transport", "stdio": 指定使用标准输入输出 (stdio) 作为通信协议
        // 如果服务器示例支持 SSE 或 WebSocket，参数可能包括 "--transport", "sse" 和 "--port", "端口号"
      ],
      "description": "对该 MCP 服务器的简要描述",
      "notes": "关于服务器运行环境或前置条件的说明，例如需要配置的认证信息环境变量（如 SALESFORCE_USERNAME, SALESFORCE_PASSWORD）"
    }
    // 如果有其他 MCP 服务器，可以在这里添加更多配置项
  ]
}

重要提示：

  • 上述 'command' 和 'args' 需要根据您实际运行 AI Assist 服务器示例的方式进行调整。对于 AI Assist 示例，通常的启动命令是 'python -m ai_assist --transport stdio' 或 'python -m ai_assist --transport sse --port 8000'。
  • AI Assist 服务器示例依赖于环境变量来获取 Salesforce 凭据（'SALESFORCE_USERNAME' 和 'SALESFORCE_PASSWORD'）。在启动服务器进程的环境中，您需要确保这些环境变量已被正确设置。客户端配置文件中不应包含敏感凭据。

请参考您的 MCP 客户端的具体文档，以了解如何在其界面或配置文件中添加和管理 MCP 服务器配置。

基本使用方法

  1. 安装 SDK： 执行 'pip install agentforce-sdk'。
  2. 设置 Salesforce 凭据： 如果您使用 AI Assist 服务器示例，请根据其要求设置 Salesforce 凭据环境变量（'SALESFORCE_USERNAME' 和 'SALESFORCE_PASSWORD'）。其他 SDK 功能可能通过代码中的 'BasicAuth' 或其他认证类配置凭据。
  3. 启动 MCP 服务器： 如果您使用 AI Assist 示例服务器，在设置好环境变量后，通过命令行启动服务器，例如 'python -m ai_assist --transport stdio'。
  4. 配置 MCP 客户端： 在您的 MCP 客户端中，按照上述“服务器配置”的说明，添加指向您已启动的服务器进程的配置。
  5. 通过客户端与服务器交互： 在 MCP 客户端界面中，您的 LLM 应该能够发现并调用由 Agentforce SDK 服务器暴露的工具和功能（例如获取 Agent 定义、调用 Agent 中的 Action 等）。

SDK 本身也提供了丰富的 Python 接口，您可以在自己的 Python 应用中直接使用 SDK 功能来构建和部署 Agent，无需通过 MCP 服务器。具体用法请参考仓库的 'examples' 目录和 'docs' 目录中的 API 文档。

信息

分类

商业系统

访问项目