根目录
协议版本: 2025-11-25
模型上下文协议(MCP)为客户端向服务器公开文件系统"根"提供了标准化方式。根定义了服务器可以在文件系统中操作的边界,允许它们了解有权访问哪些目录和文件。服务器可以从支持的客户端请求根列表,并在该列表更改时接收通知。
1 用户交互模型
MCP 中的根通常通过工作区或项目配置界面公开。
例如,实现可以提供一个工作区/项目选择器,允许用户选择服务器应有权访问的目录和文件。这可以与版本控制系统或项目文件的自动工作区检测相结合。
然而,实现可以通过任何适合其需求的界面模式公开根——协议本身不强制要求任何特定的用户交互模型。
2 能力
支持根的客户端必须在初始化期间声明 roots 能力:
json
{
"capabilities": {
"roots": {
"listChanged": true
}
}
}listChanged 表示客户端是否会在根列表更改时发出通知。
3 协议消息
3.1 列出根
要检索根,服务器发送 roots/list 请求:
请求:
json
{
"jsonrpc": "2.0",
"id": 1,
"method": "roots/list"
}响应:
json
{
"jsonrpc": "2.0",
"id": 1,
"result": {
"roots": [
{
"uri": "file:///home/user/projects/myproject",
"name": "My Project"
}
]
}
}3.2 根列表变更
当根更改时,支持 listChanged 的客户端必须发送通知:
json
{
"jsonrpc": "2.0",
"method": "notifications/roots/list_changed"
}4 消息流程
5 数据类型
5.1 Root
根定义包括:
uri:根的唯一标识符。在当前规范中,这必须是file://URI。name:可选的用于显示目的的人类可读名称。
不同用例的根示例:
5.1.1 项目目录
json
{
"uri": "file:///home/user/projects/myproject",
"name": "My Project"
}5.1.2 多个仓库
json
[
{
"uri": "file:///home/user/repos/frontend",
"name": "Frontend Repository"
},
{
"uri": "file:///home/user/repos/backend",
"name": "Backend Repository"
}
]6 错误处理
客户端应该为常见故障情况返回标准 JSON-RPC 错误:
- 客户端不支持根:
-32601(方法未找到) - 内部错误:
-32603
错误示例:
json
{
"jsonrpc": "2.0",
"id": 1,
"error": {
"code": -32601,
"message": "Roots not supported",
"data": {
"reason": "Client does not have roots capability"
}
}
}7 安全注意事项
客户端必须:
- 仅公开具有适当权限的根
- 验证所有根 URI 以防止路径遍历
- 实施适当的访问控制
- 监控根可访问性
服务器应该:
- 处理根变得不可用的情况
- 在操作期间尊重根边界
- 根据提供的根验证所有路径
8 实现指南
客户端应该:
- 在向服务器公开根之前提示用户同意
- 为根管理提供清晰的用户界面
- 在公开之前验证根可访问性
- 监控根变更
服务器应该:
- 在使用之前检查根能力
- 优雅地处理根列表变更
- 在操作中尊重根边界
- 适当地缓存根信息