概念
资源
将服务器的数据和内容暴露给LLM
资源是模型上下文协议(MCP)中的一个核心原语,它允许服务器暴露可被客户端读取并用作LLM交互上下文的数据和内容。
资源被设计为应用程序控制,这意味着客户端应用程序可以决定如何以及何时使用它们。 不同的MCP客户端可能会以不同方式处理资源。例如:
- Claude Desktop目前要求用户在使用资源之前明确选择它们
- 其他客户端可能会基于启发式规则自动选择资源
- 某些实现甚至可能允许AI模型自行决定使用哪些资源
在实现资源支持时,服务器作者应该准备好处理任何这些交互模式。为了自动向模型暴露数据,服务器作者应该使用模型控制的原语,如工具。
概述
资源代表MCP服务器想要提供给客户端的任何类型的数据。这可以包括:
- 文件内容
- 数据库记录
- API响应
- 实时系统数据
- 截图和图片
- 日志文件
- 等等
每个资源都由唯一的URI标识,可以包含文本或二进制数据。
资源URI
资源使用以下格式的URI进行标识:
例如:
file:///home/user/documents/report.pdf
postgres://database/customers/schema
screen://localhost/display1
协议和路径结构由MCP服务器实现定义。服务器可以定义自己的自定义URI方案。
资源类型
资源可以包含两种类型的内容:
文本资源
文本资源包含UTF-8编码的文本数据。这些适用于:
- 源代码
- 配置文件
- 日志文件
- JSON/XML数据
- 纯文本
二进制资源
二进制资源包含以base64编码的原始二进制数据。这些适用于:
- 图片
- PDF文件
- 音频文件
- 视频文件
- 其他非文本格式
资源发现
客户端可以通过两种主要方法发现可用资源:
直接资源
服务器通过resources/list
端点暴露具体资源列表。每个资源包括:
资源模板
对于动态资源,服务器可以暴露URI模板,客户端可以使用这些模板构造有效的资源URI:
读取资源
要读取资源,客户端需要使用资源URI发送resources/read
请求。
服务器响应包含资源内容列表:
服务器可能会对一个resources/read
请求返回多个资源。例如,当读取目录时,可以用这种方式返回目录中的文件列表。
资源更新
MCP通过两种机制支持资源的实时更新:
列表变更
服务器可以通过notifications/resources/list_changed
通知来告知客户端其可用资源列表发生变化。
内容变更
客户端可以订阅特定资源的更新:
- 客户端使用资源URI发送
resources/subscribe
- 当资源发生变化时,服务器发送
notifications/resources/updated
- 客户端可以使用
resources/read
获取最新内容 - 客户端可以使用
resources/unsubscribe
取消订阅
示例实现
这是在MCP服务器中实现资源支持的简单示例:
最佳实践
在实现资源支持时:
- 使用清晰、描述性的资源名称和URI
- 包含有助于LLM理解的描述
- 在已知时设置适当的MIME类型
- 为动态内容实现资源模板
- 对频繁变化的资源使用订阅
- 使用清晰的错误消息优雅地处理错误
- 考虑大型资源列表的分页
- 在适当时缓存资源内容
- 在处理前验证URI
- 记录您的自定义URI方案
安全考虑
在暴露资源时:
- 验证所有资源URI
- 实现适当的访问控制
- 净化文件路径以防止目录遍历
- 谨慎处理二进制数据
- 考虑资源读取的速率限制
- 审计资源访问
- 加密传输中的敏感数据
- 验证MIME类型
- 为长时间运行的读取实现超时
- 适当处理资源清理