用户交互模型
MCP 中的根目录通常通过工作区或项目配置界面暴露。 例如,实现可以提供工作区/项目选择器,允许用户选择服务器应访问的目录和文件。这可以与来自版本控制系统或项目文件的自动工作区检测相结合。 但是,实现可以通过任何适合其需求的界面模式暴露根目录——协议本身不强制任何特定的用户交互模型。能力
支持根目录的客户端必须在 初始化 期间声明roots 能力:
listChanged 指示客户端是否在根目录列表更改时发出通知。
协议消息
列出根目录
要检索根目录,服务器发送roots/list 请求:
请求:
根目录列表更改
当根目录更改时,支持listChanged 的客户端必须发送通知:
消息流
数据类型
根目录
根目录定义包括:uri: 根目录的唯一标识符。在当前规范中,这必须是file://URI。name: 可选的人类可读名称,用于显示目的。
项目目录
多个仓库
错误处理
客户端应该为常见失败情况返回标准 JSON-RPC 错误:- 客户端不支持根目录:
-32601(方法未找到) - 内部错误:
-32603
安全考虑
-
客户端必须:
- 仅暴露具有适当权限的根目录
- 验证所有根目录 URI 以防止路径遍历
- 实施适当的访问控制
- 监控根目录可访问性
-
服务器应该:
- 处理根目录变得不可用的情况
- 在操作期间尊重根目录边界
- 针对提供的根目录验证所有路径
实现指南
-
客户端应该:
- 在向服务器暴露根目录之前提示用户同意
- 提供清晰的根目录管理用户界面
- 在暴露之前验证根目录可访问性
- 监控根目录更改
-
服务器应该:
- 在使用前检查根目录能力
- 优雅地处理根目录列表更改
- 在操作中尊重根目录边界
- 适当地缓存根目录信息