Skip to main content
资源是 Model Context Protocol (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: string;           // 资源的唯一标识符
  name: string;          // 人类可读的名称
  description?: string;  // 可选描述
  mimeType?: string;     // 可选的 MIME 类型
}

​
资源模板

对于动态资源，服务器可以公开 URI 模板，客户端可以使用这些模板构造有效的资源 URI: 
{
  uriTemplate: string;   // 遵循 RFC 6570 的 URI 模板
  name: string;          // 此类型的人类可读名称
  description?: string;  // 可选描述
  mimeType?: string;     // 所有匹配资源的可选 MIME 类型
}

​
读取资源

要读取资源，客户端需要使用资源 URI 发送 resources/read 请求。 服务器以资源内容列表响应: 
{
  contents: [
    {
      uri: string;        // 资源的 URI
      mimeType?: string;  // 可选的 MIME 类型

      // 二选一:
      text?: string;      // 用于文本资源
      blob?: string;      // 用于二进制资源(base64 编码)
    }
  ]
}
服务器可以在响应一个 resources/read 请求时返回多个资源。例如，这可以用于在读取目录时返回目录内的文件列表。

​
资源更新

MCP 通过两种机制支持资源的实时更新:

​
列表变更

服务器可以通过 notifications/resources/list_changed 通知来告知客户端其可用资源列表发生变化。

​
内容变更

客户端可以订阅特定资源的更新:
  1. Client sends resources/subscribe with resource URI
  2. Server sends notifications/resources/updated when the resource changes
  3. Client can fetch latest content with resources/read
  4. Client can unsubscribe with resources/unsubscribe

​
Example implementation

Here’s a simple example of implementing resource support in an MCP server:
  • TypeScript
  • Python
const server = new Server({
  name: "example-server",
  version: "1.0.0"
}, {
  capabilities: {
    resources: {}
  }
});

// 列出可用资源
server.setRequestHandler(ListResourcesRequestSchema, async () => {
  return {
    resources: [
      {
        uri: "file:///logs/app.log",
        name: "应用日志",
        mimeType: "text/plain"
      }
    ]
  };
});

// 读取资源内容
server.setRequestHandler(ReadResourceRequestSchema, async (request) => {
  const uri = request.params.uri;

  if (uri === "file:///logs/app.log") {
    const logContents = await readLogFile();
    return {
      contents: [
        {
          uri,
          mimeType: "text/plain",
          text: logContents
        }
      ]
    };
  }

  throw new Error("资源未找到");
});

​
最佳实践

在实现资源支持时:
  1. 使用清晰、描述性的资源名称和 URI
  2. 包含有助于 LLM 理解的帮助性描述
  3. 在已知时设置适当的 MIME 类型
  4. 实现动态内容的资源模板
  5. 对频繁变化的资源使用订阅
  6. 使用清晰的错误消息优雅地处理错误
  7. 考虑对大型资源列表进行分页
  8. 适当时缓存资源内容
  9. 在处理前验证 URI
  10. 记录您的自定义 URI 方案

​
安全考虑

在公开资源时:
  • 验证所有资源 URI
  • 实现适当的访问控制
  • 净化文件路径以防止目录遍历
  • 谨慎处理二进制数据
  • 考虑资源读取的速率限制
  • 审计资源访问
  • 加密传输中的敏感数据
  • 验证 MIME 类型
  • 为长时间运行的读取实现超时
  • 适当处理资源清理