规范
规范（2024-11-05）
客户端功能
根目录

根目录

ℹ️
协议版本: 2024-11-05

模型上下文协议（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. 服务器应该：

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