项目简介

IBM Salesforce Context 是一个基于 Model Context Protocol (MCP) 构建的后端服务,旨在将 Salesforce 组织的丰富数据和操作能力无缝集成到您的集成开发环境 (IDE) 中的 AI 代理。它通过标准化的协议提供对 Salesforce 资源的访问、执行各种操作工具,并支持灵活的 Prompt 模板,帮助 AI 更智能地理解和响应开发者的需求。

主要功能点

  • Salesforce 集成: 无缝连接到 Salesforce 组织,为 AI 辅助开发提供实时上下文。
  • MCP 协议支持: 完全遵循 Model Context Protocol,确保与支持 MCP 的 IDE 和 AI 客户端兼容。
  • 资源管理: 托管并提供对 Salesforce 相关资源的访问能力,如 SObject 模式、记录前缀列表等。
  • 工具调用: 注册并执行多种 Salesforce 操作工具,包括执行 SOQL 查询、描述 SObject 结构、执行匿名 Apex 代码、部署元数据、创建元数据(Apex 类、触发器、LWC)、管理调试日志、获取最近查看的记录、执行 DML 操作以及调用 Apex REST 资源。
  • Prompt 模板: 定义可定制的 Prompt 模板,以支持不同场景下 LLM 与 Salesforce 的交互模式。
  • 灵活的传输方式: 支持标准输入输出 (Stdio) 和 HTTP 传输协议,并具备 HTTP 端口自动查找功能。
  • 状态与健康监控: 提供 '/healthz' 和 '/status' HTTP 端点,方便监控服务器健康状况、会话信息、Salesforce CLI 状态及可用的 MCP 功能。

安装步骤

  1. Node.js: 确保您的系统安装了 Node.js v22.7.0 或更新版本。您可以从 Node.js 官方网站 下载并安装。
  2. Salesforce CLI: 如果需要连接到 Salesforce 组织进行内部测试或完整功能体验,请安装并配置 Salesforce CLI (命令行界面) 并连接到一个 Salesforce 组织。
  3. 安装 MCP 服务器: IBM Salesforce Context 作为 npm 包发布。您可以使用 'npx' 命令来直接运行它,或全局安装:
    • 使用 'npx' 运行 (推荐): 'npx test_research4@latest'
    • 全局安装后运行: 'npm install -g test_research4',然后运行 'test_research4'

服务器配置

MCP 服务器需要通过您的 MCP 客户端进行配置。以下是典型的配置示例,请在您的 MCP 客户端 (例如 VS Code, Cursor 等) 的 MCP 设置中添加此配置:

  • 通过 Stdio 传输 (默认):

    {
      "name": "salesforce",
      "command": "npx",
      "args": [
        "test_research4@latest"
      ]
    }

    说明:此配置将使用默认的 'stdio' 传输协议。

  • 通过 HTTP 传输 (自定义端口):

    {
      "name": "salesforce",
      "command": "npx",
      "args": [
        "test_research4@latest",
        "--transport", "http",
        "--port", "8080"
      ]
    }

    说明:此配置将使用 'http' 传输协议,并在 '8080' 端口上运行。如果端口被占用,服务器会自动寻找下一个可用端口。

  • 设置日志级别和工作区路径:

    {
      "name": "salesforce",
      "command": "npx",
      "args": [
        "test_research4@latest",
        "--transport", "stdio",
        "--log-level", "debug",
        "--workspace", "/path/to/your/project"
      ]
    }

    说明:您可以通过 '--log-level' 设置日志级别(例如 'debug', 'info', 'warning', 'error'),并通过 '--workspace' 指定项目的工作区路径,服务器将在此路径下查找文件或创建临时文件。

  • 配置参数说明:

    • 'name': 服务器在客户端中显示的名称(例如 "salesforce")。
    • 'command': 启动 MCP 服务器的命令,通常是 'npx' 或已全局安装的包名。
    • 'args': 传递给 MCP 服务器命令的参数列表。
      • '--transport [stdio|http]': 指定传输协议,可选 'stdio' 或 'http'。
      • '--port [端口号]': 仅适用于 'http' 传输,指定 HTTP 服务器监听的端口。
      • '--log-level [级别]': 设置服务器的日志输出级别(如 'debug', 'info', 'warning', 'error')。
      • '--workspace [路径]': 指定项目工作区路径(逗号分隔,如果有多个则取第一个)。
      • '--help': 显示帮助信息。
      • '--version': 显示版本信息。

基本使用方法

一旦服务器在您的 MCP 客户端中配置并启动,您的 AI 代理就可以通过 MCP 协议与它进行通信:

  1. 请求上下文信息: AI 代理可以调用服务器的“资源”功能,获取 Salesforce SObject 模式、最近查看的记录等数据。
  2. 执行 Salesforce 操作: AI 代理可以调用服务器暴露的“工具”来执行 Salesforce DML 操作、SOQL 查询、Apex 代码执行等。例如,代理可以请求执行一个 SOQL 查询来获取账户列表。
  3. 获取 Prompt 模板: AI 代理可以请求服务器生成预定义的 Prompt 模板,以指导其与用户的交互或代码生成任务。

通常,这些交互都是由支持 MCP 的 AI 代理在后台自动完成的,您只需在 IDE 中使用 AI 代理即可体验增强的 Salesforce 开发辅助功能。

信息

分类

商业系统