box-mcp-server

🚀 box-mcp-server

box-mcp-server 是一个用于与 Box 服务集成的工具，可实现文件搜索与读取等功能，支持多种认证方式，方便开发者进行开发与配置。

🚀 快速开始

你需要配置以下环境变量来使用 box-mcp-server：

• BOX_USER_ID

以及以下其中一种方式之一：

• BOX_JWT_BASE64（推荐）
• BOX_JWT_CONFIG_PATH
• BOX_JWT

✨ 主要特性

1. 搜索文件：可在 Box 中搜索文件。
2. 读取文件：支持读取 PDF 和 Word 文件，其他文件类型待支持。
   • [x] PDF
   • [x] Word
   • [ ] 其他

📦 安装指南

开发环境设置

在开始开发之前，请确保你已安装以下软件：

• Node.js（推荐 v22 或更高版本）
• npm
• git
• dotenv

按照以下步骤设置开发环境：

1. 叉克仓库
   • 点击此仓库右上角的“叉克”按钮，在你自己的 Github 账户下创建该仓库的副本。
2. 克隆你的副本

   git clone https://github.com/YOUR_USERNAME/box-mcp-server.git
   cd box-mcp-server
   

3. 添加上游远程仓库

   git remote add upstream https://github.com/hmk/box-mcp-server.git
   

4. 复制 dotenv 文件

   cp .env.template .env
   

5. 安装依赖

   npm install
   

6. 运行看门狗以保持 index.js 更新

   npm run watch
   

7. 启动模型上下文协议开发服务器

   dotenv npx @modelcontextprotocol/inspector node PATH_TO_YOUR_CLONED_REPO/dist/index.js
   

8. 环境变量加载问题处理 如果开发服务器未能正确加载环境变量，请在 mcp 检查器的左侧设置 BOX_DEV_TOKEN。

📚 详细文档

认证

JSON Web Token (JWT) 授权（推荐）

如何获取 JWT

使用 JWT 配置可以实现与 Box 的持久连接。你需要一个付费的 Box 企业账户，或者你可以注册一个免费开发者账户（请确保在点击该链接之前已退出 Box）。访问 Box 开发者控制台，创建一个新的应用程序。如果你还没有设置，请确保你已经设置了双重因素认证，并且作为管理员在你的 Box 账户中授权该应用。你需要：

1. 给应用程序授予 App + 企业访问 权限。
2. 启用 使用 as - user 标头进行 API 调用 选项。

通过 Box 应用的配置页面。如果你修改了这些设置，请确保重新授权该应用。

Base64 编码 JWT

要对你的 JWT 进行 Base64 编码，可以在终端中使用以下命令：

cat /path/to/your/box-jwt-config.json | base64

将 /path/to/your/box-jwt-config.json 替换为你实际的 JWT 配置文件路径。这会输出 Base64 编码的 JWT，你可以将其用于环境变量。

Claude Desktop 配置

{
  "mcpServers": {
    "box": {
      "command": "npx",
      "args": ["box-mcp-server"],
      "env": {
        "BOX_JWT_BASE64": "YOUR_BASE64_ENCODED_JWT",
        "BOX_USER_ID": "123456"
      }
    }
  }
}

开发者令牌授权（最简单）

使用开发者令牌是与 Box 集成的最简单方式，但仅持续 60 分钟。 要开始，请将 BOX_DEV_TOKEN 设置为一个Box 开发者令牌。 首先访问 Box 开发者控制台，创建一个新的应用程序。此时授权类型并不重要，因为所有支持 Box 开发者令牌的应用程序都会被支持。 一旦你的应用程序创建完成，请导航到其配置设置并点击 生成开发者令牌。

Claude Desktop 配置

{
  "mcpServers": {
    "box": {
      "command": "npx",
      "args": ["box-mcp-server"],
      "env": {
        "BOX_DEV_TOKEN": "YOUR_DEV_TOKEN_GOES_HERE"
      }
    }
  }
}