使用说明

项目简介

该项目实现了一个基于 Model Context Protocol (MCP) 的服务器,名为 Storm MCP Server。它主要用于桥接大型语言模型 (LLM) 应用和 Sionic AI 的 Storm Platform 提供的检索增强生成 (RAG) 功能。通过这个服务器,LLM 客户端(如 Claude Desktop)可以利用 Storm Platform 的数据资源和工具,实现更强大的上下文感知和功能扩展。

主要功能点

  • 上下文共享: 遵循 MCP 标准协议,为 LLM 提供结构化的上下文信息。
  • 工具系统: 提供一系列预定义的工具,允许 LLM 调用 Storm Platform 的功能,例如:
    • 'send_nonstream_chat': 向 Storm Platform 发送非流式聊天请求并获取答案。
    • 'list_agents': 列出 Storm Platform 中可用的 Agent (智能体)。
    • 'list_buckets': 列出指定 Agent 下的 Bucket (知识库)。
    • 'upload_document_by_file': 上传文件到指定的 Bucket 中。
  • 文件管理: 提供基本的文件管理功能,允许 LLM 客户端上传和搜索文件(通过独立的 'file-server' 组件)。
  • API 集成: 深度集成了 Sionic AI Storm Platform 的 REST API,利用 Storm 平台的强大 RAG 能力。

安装步骤

  1. 克隆仓库: 将 GitHub 仓库 'serverless-rag-mcp-server' 克隆到本地。
    git clone https://github.com/sionic-ai/serverless-rag-mcp-server
    cd serverless-rag-mcp-server
  2. 配置 API Key: 编辑 'scripts/run.sh' 文件,在 'export STORM_API_KEY=''' 行中填入你的 Sionic AI Storm Platform API Key。你需要在 Sionic AI Storm Platform 注册并获取 API Key。
    vim scripts/run.sh  # 或使用你喜欢的编辑器
    修改 'scripts/run.sh' 文件内容,例如:
    #!/bin/bash
    
    export STORM_API_KEY='YOUR_API_KEY_HERE' # 将 YOUR_API_KEY_HERE 替换为你的API Key
    python storm_mcp_server/main.py
  3. 运行服务器: 在仓库根目录下,运行 'scripts/run.sh' 脚本启动 MCP 服务器。
    sh scripts/run.sh
    服务器默认通过标准输入/输出 (stdio) 与 MCP 客户端通信。

服务器配置

对于 MCP 客户端(例如 Claude Desktop),你需要配置连接到 Storm MCP Server 的信息。配置信息通常以 JSON 格式提供。以下是根据仓库信息生成的 Claude Desktop 配置文件示例:

{
  "mcpServers": {
    "storm": {  // 服务器名称,可以自定义,例如 "storm-rag"
      "command": "sh",  // 启动服务器的命令,这里使用 shell 脚本
      "args": [
        "/path/to/serverless-rag-mcp-server/scripts/run.sh" //  'run.sh' 脚本的绝对路径,请替换为你的实际路径
      ]
    }
  }
}

配置参数说明:

  • '"storm"': MCP 服务器的名称,在客户端中用于标识和选择该服务器。你可以自定义服务器名称。
  • '"command": "sh"': 指定用于启动服务器的命令解释器,这里使用 'sh' (shell)。
  • '"args": [...]': 一个字符串数组,包含传递给 'command' 的参数。
    • '"/path/to/serverless-rag-mcp-server/scripts/run.sh"': 请务必替换为 'run.sh' 脚本在你的文件系统中的绝对路径。这是启动 Storm MCP Server 的关键参数。

Claude Desktop 配置步骤:

  1. 打开 Claude Desktop 的配置文件 '~/Library/Application\ Support/Claude/claude_desktop_config.json' (macOS)。
  2. 将上述 JSON 配置代码添加到 'claude_desktop_config.json' 文件的 '"mcpServers"' 字段中。如果 'mcpServers' 字段不存在,则创建它。

基本使用方法

配置完成后,在 Claude Desktop 中,你就可以选择配置的 "storm" MCP 服务器。Claude 将能够通过 Storm MCP Server 调用 Storm Platform 提供的工具和访问相关资源,例如:

  • 在 Claude 中提问时,可以指示 Claude 使用 'send_nonstream_chat' 工具,利用 Storm Platform 的 RAG 能力进行回答。
  • 可以使用 'list_buckets' 工具查看可用的知识库,并指定知识库进行更精准的问答。
  • 可以使用 'upload_document_by_file' 工具上传新的文档到知识库中。

具体的工具调用方式取决于 MCP 客户端(如 Claude Desktop)的界面和功能。请参考 MCP 客户端的文档来了解如何使用配置的 MCP 服务器和工具。

注意:

  • 'file-server' 是一个独立的 MCP 服务器,用于文件管理功能。目前仓库信息中没有明确的使用说明,但从代码结构来看,它可能需要单独启动和配置。
  • 请确保你的 Sionic AI Storm Platform API Key 配置正确,否则服务器将无法正常连接到 Storm Platform。
  • 路径配置(如 'run.sh' 脚本路径)需要根据你的实际环境进行调整。

信息

分类

AI与计算