返回 MCP 目录
public公开dns本地运行

hmk_box-mcp-server

Box平台的MCP服务项目,支持开发者令牌认证,提供文件搜索和阅读功能(目前支持PDF和Word格式)。

article

README

🚀 使用说明

本使用说明主要介绍了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": "在此处放置你的开发者令牌"
      }
    }
  }
}

✨ 主要特性

  • 文件搜索:支持搜索文件。
  • 文件读取:支持读取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
help

运行方式说明

cloud

托管运行

托管运行通常表示这个 MCP Server 由服务方环境承载,用户一般按页面提供的连接方式或授权流程接入,不需要在本地长期启动一个 MCP 进程

  1. 打开服务方连接页
  2. 完成授权或复制端点
  3. 在 MCP 客户端中连接
terminal

本地运行 / 其它方式

本地运行通常需要用户在自己的电脑或服务器上安装依赖,把 server_config 复制到 MCP 客户端,并按 env_schema 补齐环境变量、密钥或其它配置

  1. 复制 server_config
  2. 安装所需依赖
  3. 补齐环境变量后重启客户端