使用说明

项目简介

Box MCP Server 是一个基于 Model Context Protocol (MCP) 构建的服务器应用,它利用 Box API 实现了对 Box 云存储平台的强大集成。该项目旨在为大型语言模型 (LLM) 应用提供一个桥梁,使得 LLM 能够安全、高效地访问和利用 Box 平台上的文件和数据。通过标准化的 MCP 协议,Box MCP Server 允许 LLM 客户端调用预定义的工具,从而实现文件搜索、内容提取、AI 智能问答、数据解析等多种功能,极大地扩展了 LLM 应用的上下文理解和数据处理能力。

主要功能点

  • Box 文件操作工具: 提供一系列工具,用于在 Box 云存储中执行文件和文件夹的搜索、读取、上传、下载和管理等操作。
  • AI 增强功能: 集成了 Box AI 的能力,允许 LLM 通过工具调用,对 Box 文件内容进行智能问答和数据抽取。
  • Claude 客户端支持: 特别优化了与 Claude LLM 客户端的集成,提供了详细的配置指南,方便用户快速上手。
  • 灵活的部署方式: 支持通过标准输入输出 (stdio) 协议与 MCP 客户端通信,易于集成到各种 LLM 应用环境中。
  • 完善的测试套件: 包含全面的测试用例,确保 Box API 功能的稳定性和可靠性。

安装步骤

  1. 克隆仓库

    git clone https://github.com/box-community/mcp-server-box.git
    cd mcp-server-box
  2. 安装 uv (可选,推荐使用) 项目推荐使用 'uv' 包管理器,如果尚未安装,请根据操作系统执行安装命令:

    • MacOS/Linux:
      curl -LsSf https://astral.sh/uv/install.sh | sh
    • Windows:
      powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"
  3. 创建并激活虚拟环境 在项目根目录下创建并激活 Python 虚拟环境,以隔离项目依赖:

    • MacOS/Linux:
      uv venv
      source .venv/bin/activate
    • Windows:
      uv venv
      .venv\Scripts\activate
  4. 锁定依赖 使用 'uv lock' 安装项目依赖:

    uv lock
  5. 配置 Box API 凭证 在项目根目录下创建 '.env' 文件,并填入您的 Box API 凭证。请确保您已在 Box 开发者控制台中创建应用并获取以下凭证:

    BOX_CLIENT_ID=your_client_id
    BOX_CLIENT_SECRET=your_client_secret

服务器配置

为了让 MCP 客户端(例如 Claude)连接到 Box MCP Server,您需要在客户端的配置文件中添加服务器配置信息。以 Claude 客户端为例,您需要编辑 'claude_desktop_config.json' 文件,并添加如下 'mcpServers' 配置:

{
    "mcpServers": {
        "box-mcp-server": {  // 服务器名称,可以自定义
            "command": "uv",  // 启动服务器的命令,这里使用 uv
            "args": [         // 启动命令的参数列表
                "--directory",  // 指定工作目录
                "/Users/anovotny/Desktop/mcp-server-box", // 请替换为您的 mcp-server-box 项目的实际路径
                "run",          // uv run 命令,用于运行 Python 脚本
                "src/mcp_server_box.py" // MCP 服务器的 Python 脚本路径
            ]
        }
    }
}

请注意:

  • '"box-mcp-server"' 可以自定义为任何您喜欢的服务器名称。
  • '"/Users/anovotny/Desktop/mcp-server-box"' 必须替换 为您本地 'mcp-server-box' 项目的实际存放路径。
  • 如果您的环境中 'uv' 命令不在 PATH 环境变量中,您可能需要提供 'uv' 命令的完整路径。

基本使用方法

  1. 启动 MCP 服务器 在项目根目录下,运行以下命令启动 Box MCP Server:

    uv --directory /Users/anovotny/Desktop/mcp-server-box run src/mcp_server_box.py

    同样需要注意: 将 '/Users/anovotny/Desktop/mcp-server-box' 替换为您的项目实际路径。

  2. 配置 MCP 客户端 根据您使用的 MCP 客户端(例如 Claude),按照其文档指引配置连接到 Box MCP Server。通常需要提供服务器名称以及启动命令和参数。

  3. 在 MCP 客户端中使用工具 一旦客户端成功连接到 Box MCP Server,您就可以在客户端中使用 Box MCP Server 提供的各种工具了。工具的具体使用方法请参考每个工具的描述和参数说明。例如,在 Claude 中,您可以使用 '@box-mcp-server.box_search_tool' 来调用文件搜索工具。

运行测试

如果您需要验证 Box API 功能或者进行开发,可以运行项目提供的测试套件。

  1. 更新测试文件 ID 在 'tests/' 目录下,根据测试文件的说明,更新测试文件中硬编码的文件和文件夹 ID,替换为您 Box 账户中实际存在的文件和文件夹 ID。

  2. 运行测试 运行以下命令执行测试:

    pytest

    您还可以使用 'pytest -v' 查看详细输出,或使用 'pytest -s' 显示打印语句。

信息

分类

数据库与文件