🚀 使用说明

本项目提供了一个MCP服务器，支持搜索和读取文件等功能。下面将详细介绍开发者令牌授权、Claude Desktop配置、功能概述以及开发环境的设置。

🚀 快速开始

开发者令牌授权

目前，此MCP服务器仅支持开发者令牌认证。你需要将BOX_DEV_TOKEN设置为Box开发者令牌。具体步骤如下：

1. 访问Box开发者控制台，创建一个新的应用。授权类型目前无关紧要，因为所有支持Box开发者令牌的应用都可以使用。
2. 应用程序创建完成后，导航到其配置设置并点击生成开发者令牌。

Claude Desktop配置

{
  "mcpServers": {
    "box": {
      "command": "npx",
      "args": [
        "box-mcp-server"
      ],
      "env": {
        "BOX_DEV_TOKEN": "在此处放置你的开发者令牌"
      }
    }
  }
}

✨ 主要特性

1. 搜索文件：可在系统中搜索所需文件。
2. 读取文件：支持读取PDF和Word文件，其他文件类型暂不支持。
   • [x] PDF
   • [x] Word
   • [ ] 其他

📦 安装指南

先决条件

在开始之前，请确保安装了以下内容：

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

设置开发环境

要设置开发环境，请按照以下步骤操作：

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. 安装依赖项：

   npm install
   

5. 设置BOX_DEV_TOKEN环境变量：

   export BOX_DEV_TOKEN=your_developer_token
   

6. 运行监视以保持index.js更新：

   npm run watch
   

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

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

8. 特殊情况处理：如果开发服务器未能正确加载环境变量，请在MCP检查仪的左手边设置BOX_DEV_TOKEN。