使用说明

项目简介

mcp-server-salesforce 是一个基于 Model Context Protocol (MCP) 的服务器实现。它提供了一个简单的笔记管理系统,允许用户通过 MCP 客户端添加、存储和总结笔记。虽然仓库名称包含 Salesforce,但当前版本主要演示了笔记功能,可以作为与 Salesforce 或其他数据源集成的 MCP 服务器的基础。

主要功能点

  • 笔记资源管理:允许创建、存储和访问笔记,每篇笔记都有唯一的 URI (例如:'note://internal/笔记名称')。
  • 笔记总结 Prompt:提供名为 'summarize-notes' 的 Prompt 模板,可以生成所有已存储笔记的摘要,并支持通过可选参数 'style' 控制摘要的详细程度('brief' 或 'detailed')。
  • 添加笔记工具:提供名为 'add-note' 的工具,允许用户通过指定笔记的名称 ('name') 和内容 ('content') 添加新的笔记。添加笔记后,服务器会通知客户端资源已更新。

安装步骤

此 MCP 服务器无需单独安装,通常与 MCP 客户端(例如 Claude Desktop)配合使用。您需要配置 MCP 客户端以连接到此服务器。

服务器配置

要将此 MCP 服务器添加到 MCP 客户端,您需要配置客户端的服务器列表。以下是针对 开发/未发布服务器 的配置示例,通常用于本地调试和开发。您需要根据 'mcp-server-salesforce' 仓库在您本地文件系统中的实际路径进行调整。

{
  "mcpServers": {
    "mcp-server-salesforce": {
      "command": "uv",
      "args": [
        "--directory",
        "/path/to/mcp-server-salesforce",
        "run",
        "mcp-server-salesforce"
      ]
    }
  }
}
  • '"mcp-server-salesforce"': 服务器的名称,在客户端中用于标识和引用。
  • '"command": "uv"': 启动服务器的命令。这里 'uv' 是一个 Python 包管理和运行工具,你需要确保你的环境中安装了 'uv'。如果使用 'pip',可能需要替换为 'python -m' 或直接使用虚拟环境的 Python 解释器路径。
  • '"args"': 传递给命令的参数列表。
    • '"--directory"': 指定服务器代码所在的目录,这里需要替换为 'mcp-server-salesforce' 仓库的实际本地路径,例如 '/Users/yourusername/Projects/mcp-server-salesforce'。
    • '"run"': 'uv run' 的子命令,用于运行指定的 Python 包或模块。
    • '"mcp-server-salesforce"': 要运行的 Python 包或模块名称。这里 'mcp-server-salesforce' 指的是仓库根目录下的 'src/mcp_server_salesforce' 包。

注意: 请将 '/path/to/mcp-server-salesforce' 替换为 'mcp-server-salesforce' 仓库在您本地文件系统中的实际路径。

基本使用方法

配置完成后,启动 MCP 客户端(如 Claude Desktop)。客户端应该能够自动发现并连接到 'mcp-server-salesforce' 服务器。之后,您可以通过客户端与服务器进行交互,例如:

  1. 使用 Prompt 总结笔记: 在客户端中选择或触发 'summarize-notes' Prompt,让 LLM 生成当前所有笔记的摘要。您可以尝试传递 'style: detailed' 参数以获取更详细的摘要。
  2. 使用工具添加笔记: 在客户端中调用 'add-note' 工具,并提供笔记的 'name' 和 'content' 参数。添加成功后,您存储的笔记资源将会更新。
  3. 访问笔记资源: 客户端可以使用 'note://internal/笔记名称' 格式的 URI 来访问和读取特定的笔记内容。

信息

分类

商业系统