Superface MCP 服务器使用说明

项目简介

Superface MCP 服务器是一个基于 Model Context Protocol (MCP) 的后端实现,它允许大型语言模型 (LLM) 客户端通过标准化的 MCP 协议访问和使用 Superface 平台提供的各种工具。该服务器充当 LLM 和 Superface 工具之间的桥梁,扩展了 LLM 的能力边界,使其能够调用外部功能完成更复杂的任务。

主要功能点

  • 工具发现: 允许 LLM 客户端查询并获取 Superface 平台提供的可用工具列表及其详细信息(如名称、描述、输入参数)。
  • 工具调用: 接收来自 LLM 客户端的工具调用请求,并代表客户端执行 Superface 平台上的工具。
  • 标准 MCP 协议: 使用 JSON-RPC over Stdio 与 LLM 客户端通信,遵循 MCP 协议规范。
  • Superface 集成: 无缝集成 Superface 平台,利用 Superface 丰富的工具生态系统。

安装步骤

该项目本身无需手动安装,因为它以可执行程序或 Docker 镜像的形式提供。您可以通过 NPX 直接运行,或者使用 Docker 镜像。 前提是您需要安装 Node.js 和 npm (如果使用 NPX) 或 Docker (如果使用 Docker)。

服务器配置

对于 MCP 客户端(例如 Claude Desktop),您需要配置 MCP 服务器的连接信息。以下是针对不同运行方式的配置示例,请根据您的选择进行配置。请务必将 '<YOUR_API_KEY>' 替换为您在 Superface 仪表板获取的 API 密钥。

NPX 方式配置 (推荐开发测试使用)

将以下 JSON 配置添加到您的 MCP 客户端配置文件中 (例如 'claude_desktop_config.json'):

{
  "mcpServers": {
    "superface": {
      "command": "npx",
      "args": [
        "-y",
        "@superfaceai/mcp"
      ],
      "env": {
        "SUPERFACE_API_KEY": "<YOUR_API_KEY>"  // 您的 Superface API 密钥
      }
    }
  }
}
  • 'server name': 'superface' (服务器名称,客户端用于标识和引用)
  • 'command': 'npx' (启动服务器的命令,这里使用 Node.js 包执行器 npx)
  • 'args': '["-y", "@superfaceai/mcp"]' (传递给 'npx' 的参数,'-y' 表示自动确认安装包,'@superfaceai/mcp' 是要执行的 npm 包名)
  • 'env': '{"SUPERFACE_API_KEY": "<YOUR_API_KEY>"}' (环境变量配置,'SUPERFACE_API_KEY' 用于服务器鉴权,请替换为您的实际 API 密钥)

Docker 方式配置 (推荐生产环境使用)

如果您选择使用 Docker 运行 Superface MCP 服务器,请先构建 Docker 镜像(参考仓库 'README.md' 中的 Docker build 命令),然后将以下 JSON 配置添加到您的 MCP 客户端配置文件中:

{
  "mcpServers": {
    "superface": {
      "command": "docker",
      "args": [
        "run",
        "-i",
        "--rm",
        "-e",
        "SUPERFACE_API_KEY",
        "mcp/superface"
      ],
      "env": {
        "SUPERFACE_API_KEY": "<YOUR_API_KEY>"  // 您的 Superface API 密钥
      }
    }
  }
}
  • 'server name': 'superface' (服务器名称)
  • 'command': 'docker' (启动服务器的命令,这里使用 Docker 客户端)
  • 'args': '["run", "-i", "--rm", "-e", "SUPERFACE_API_KEY", "mcp/superface"]' (传递给 'docker run' 的参数:
    • 'run': 运行容器
    • '-i': 保持标准输入 (STDIN) 打开,即使未连接。
    • '--rm': 容器退出后自动删除容器
    • '-e SUPERFACE_API_KEY': 设置环境变量 'SUPERFACE_API_KEY'
    • 'mcp/superface': Docker 镜像名称,假设您已构建并命名为 'mcp/superface' )
  • 'env': '{"SUPERFACE_API_KEY": "<YOUR_API_KEY>"}' (环境变量配置,与 args 中的 '-e' 重复,建议只保留 'args' 中的 '-e' 配置)

基本使用方法

配置完成后,您的 MCP 客户端 (如 Claude Desktop) 将能够连接到 Superface MCP 服务器。您可以通过客户端的界面或指令,利用 Superface 提供的工具来增强 LLM 的功能。具体工具的使用方式和效果取决于 Superface 平台提供的工具种类和功能。

请确保您已在 Superface 仪表板中添加了您希望使用的工具,并获取了有效的 API 密钥。

信息

分类

AI与计算