> ## Documentation Index
> Fetch the complete documentation index at: https://mcp.developerdoc.cn/llms.txt
> Use this file to discover all available pages before exploring further.

# 根目录

<div id="enable-section-numbers" />

Model Context Protocol (MCP) 为客户端向服务器公开文件系统“根目录”提供了标准化方式。
根目录定义了服务器可在文件系统中操作的边界，使服务器能够了解自己可以访问哪些目录和文件。
服务器可以从支持根目录的客户端请求根目录列表，并在该列表发生变化时接收通知。

## 用户交互模型

MCP 中的根目录通常通过工作区或项目配置界面公开。

例如，实现可以提供工作区/项目选择器，让用户选择服务器应能访问的目录和文件。
这也可以与基于版本控制系统或项目文件的自动工作区检测结合使用。

不过，实现可以自由地通过任何适合自身需求的界面模式公开根目录；
协议本身并不强制规定任何特定的用户交互模型。

## 能力

支持根目录的客户端在[初始化](/specification/2025-11-25/basic/lifecycle#initialization)期间
**MUST** 声明 `roots` 能力：

```json theme={null}
{
  "capabilities": {
    "roots": {
      "listChanged": true
    }
  }
}
```

`listChanged` 表示客户端是否会在根目录列表变化时发出通知。

## 协议消息

### 列出根目录

为了获取根目录，服务器会发送 `roots/list` 请求：

**请求：**

```json theme={null}
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "roots/list"
}
```

**响应：**

```json theme={null}
{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "roots": [
      {
        "uri": "file:///home/user/projects/myproject",
        "name": "My Project"
      }
    ]
  }
}
```

### 根目录列表变化

当根目录发生变化时，支持 `listChanged` 的客户端 **MUST** 发送通知：

```json theme={null}
{
  "jsonrpc": "2.0",
  "method": "notifications/roots/list_changed"
}
```

## 消息流

```mermaid theme={null}
sequenceDiagram
    participant Server
    participant Client

    Note over Server,Client: Discovery
    Server->>Client: roots/list
    Client-->>Server: Available roots

    Note over Server,Client: Changes
    Client--)Server: notifications/roots/list_changed
    Server->>Client: roots/list
    Client-->>Server: Updated roots
```

## 数据类型

### Root

根目录定义包括：

* `uri`：根目录的唯一标识符。在当前规范中，这 **MUST** 是一个 `file://` URI。
* `name`：用于显示的可选人类可读名称。

不同用例下的根目录示例：

#### 项目目录

```json theme={null}
{
  "uri": "file:///home/user/projects/myproject",
  "name": "My Project"
}
```

#### 多个仓库

```json theme={null}
[
  {
    "uri": "file:///home/user/repos/frontend",
    "name": "Frontend Repository"
  },
  {
    "uri": "file:///home/user/repos/backend",
    "name": "Backend Repository"
  }
]
```

## 错误处理

客户端 **SHOULD** 针对常见失败情况返回标准 JSON-RPC 错误：

* 客户端不支持根目录：`-32601`（Method not found）
* 内部错误：`-32603`

错误示例：

```json theme={null}
{
  "jsonrpc": "2.0",
  "id": 1,
  "error": {
    "code": -32601,
    "message": "Roots not supported",
    "data": {
      "reason": "Client does not have roots capability"
    }
  }
}
```

## 安全注意事项

1. 客户端 **MUST**:
   * 仅公开具有适当权限的根目录
   * 验证所有根目录 URI，防止路径遍历
   * 实现适当的访问控制
   * 监控根目录可访问性

2. 服务器 **SHOULD**:
   * 处理根目录变得不可用的情况
   * 在操作期间遵守根目录边界
   * 根据提供的根目录验证所有路径

## 实现指南

1. 客户端 **SHOULD**:
   * 在向服务器公开根目录前提示用户同意
   * 提供清晰的根目录管理用户界面
   * 在公开前验证根目录可访问性
   * 监控根目录变化

2. 服务器 **SHOULD**:
   * 在使用前检查根目录能力
   * 妥善处理根目录列表变化
   * 在操作中遵守根目录边界
   * 适当地缓存根目录信息