Skip to main content
协议修订版: 2025-03-26
模型上下文协议(MCP)为客户端向服务器暴露文件系统“根目录”提供了标准化的方式。根目录定义了服务器在文件系统中可操作的边界,使其能够了解可以访问的目录和文件。服务器可以从支持该功能的客户端请求根目录列表,并在列表发生变化时接收通知。

用户交互模型

在MCP中,根目录通常通过工作区或项目配置界面暴露。 例如,实现可以提供一个工作区/项目选择器,允许用户选择服务器应访问的目录和文件。这可以与版本控制系统或项目文件中的自动工作区检测结合使用。 不过,实现可以通过任何适合其需求的界面模式暴露根目录——协议本身不强制要求任何特定的用户交互模型。

能力声明

支持根目录的客户端必须初始化期间声明 roots 能力:
{
  "capabilities": {
    "roots": {
      "listChanged": true
    }
  }
}
listChanged 表示当根目录列表更改时,客户端是否会发出通知。

协议消息

列出根目录

要获取根目录,服务器发送 roots/list 请求: 请求:
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "roots/list"
}
响应:
{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "roots": [
      {
        "uri": "file:///home/user/projects/myproject",
        "name": "我的项目"
      }
    ]
  }
}

根目录列表更改

当根目录发生变化时,支持 listChanged 的客户端必须发送通知:
{
  "jsonrpc": "2.0",
  "method": "notifications/roots/list_changed"
}

消息流程

数据类型

根目录(Root)

一个根目录定义包括:
  • uri:根目录的唯一标识符。根据当前规范,这必须是一个 file:// URI。
  • name:可选的、用于显示的可读名称。
不同使用场景下的根目录示例:

项目目录

{
  "uri": "file:///home/user/projects/myproject",
  "name": "我的项目"
}

多个仓库

[
  {
    "uri": "file:///home/user/repos/frontend",
    "name": "前端仓库"
  },
  {
    "uri": "file:///home/user/repos/backend",
    "name": "后端仓库"
  }
]

错误处理

客户端为常见失败情况返回标准 JSON-RPC 错误:
  • 客户端不支持根目录:-32601(方法未找到)
  • 内部错误:-32603
示例错误:
{
  "jsonrpc": "2.0",
  "id": 1,
  "error": {
    "code": -32601,
    "message": "不支持根目录",
    "data": {
      "reason": "客户端不具有根目录能力"
    }
  }
}

安全考虑

  1. 客户端必须
    • 仅以适当权限暴露根目录
    • 验证所有根目录 URI 以防止路径遍历
    • 实施适当的访问控制
    • 监控根目录的可访问性
  2. 服务器
    • 处理根目录不可用的情况
    • 在操作中尊重根目录边界
    • 针对提供的根目录验证所有路径

实现指南

  1. 客户端
    • 在向服务器暴露根目录前提示用户确认
    • 提供清晰的根目录管理用户界面
    • 在暴露前验证根目录的可访问性
    • 监控根目录的变化
  2. 服务器
    • 使用前检查根目录能力
    • 优雅地处理根目录列表变化
    • 在操作中尊重根目录边界
    • 合理缓存根目录信息