规范
规范（最新）
客户端功能
根目录

根目录

ℹ️
协议修订版: 2024-11-05

Model Context Protocol (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"
}

消息流 

sequenceDiagram
    participant Server
    participant Client

    Note over Server,Client: 发现
    Server->>Client: roots/list
    Client-->>Server: 可用的根目录

    Note over Server,Client: 更改
    Client--)Server: notifications/roots/list_changed
    Server->>Client: roots/list
    Client-->>Server: 更新的根目录

数据类型

根目录

根目录定义包括：

  • 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. 服务器 应：

    • 在使用前检查根目录能力
    • 优雅地处理根目录列表更改
    • 在操作中尊重根目录边界
    • 适当地缓存根目录信息
采样