规范
规范（2024-11-05）
服务器功能
资源

资源

ℹ️
协议版本: 2024-11-05

模型上下文协议（MCP）为服务器向客户端公开资源提供了标准化方式。资源允许服务器共享为语言模型提供上下文的数据，如文件、数据库模式或应用程序特定信息。每个资源由URI唯一标识。

用户交互模型

MCP 中的资源被设计为应用程序驱动，由宿主应用程序根据其需求决定如何合并上下文。

例如，应用程序可以：

  • 通过 UI 元素公开资源以供明确选择，在树或列表视图中
  • 允许用户搜索和过滤可用资源
  • 实现基于启发式或 AI 模型选择的自动上下文包含

资源上下文选择器示例

然而，实现可以通过任何适合其需求的接口模式公开资源—协议本身不强制任何特定的用户交互模型。

能力

支持资源的服务器必须声明 resources 能力：

{
  "capabilities": {
    "resources": {
      "subscribe": true,
      "listChanged": true
    }
  }
}

该能力支持两个可选功能：

  • subscribe：客户端是否可以订阅以接收有关单个资源更改的通知。
  • listChanged：服务器是否会在可用资源列表更改时发出通知。

subscribe 和 listChanged 都是可选的—服务器可以不支持、支持其中之一或两者都支持：

{
  "capabilities": {
    "resources": {} // 两个功能都不支持
  }
}
{
  "capabilities": {
    "resources": {
      "subscribe": true // 仅支持订阅
    }
  }
}
{
  "capabilities": {
    "resources": {
      "listChanged": true // 仅支持列表更改通知
    }
  }
}

协议消息

列出资源

要发现可用资源，客户端发送 resources/list 请求。此操作支持分页。

请求：

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "resources/list",
  "params": {
    "cursor": "可选的游标值"
  }
}

响应：

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "resources": [
      {
        "uri": "file:///project/src/main.rs",
        "name": "main.rs",
        "description": "应用程序主入口点",
        "mimeType": "text/x-rust"
      }
    ],
    "nextCursor": "下一页游标"
  }
}

读取资源

要检索资源内容，客户端发送 resources/read 请求：

请求：

{
  "jsonrpc": "2.0",
  "id": 2,
  "method": "resources/read",
  "params": {
    "uri": "file:///project/src/main.rs"
  }
}

响应：

{
  "jsonrpc": "2.0",
  "id": 2,
  "result": {
    "contents": [
      {
        "uri": "file:///project/src/main.rs",
        "mimeType": "text/x-rust",
        "text": "fn main() {\n    println!(\"Hello world!\");\n}"
      }
    ]
  }
}

资源模板

资源模板允许服务器使用URI 模板公开参数化资源。参数可以通过补全 API自动补全。

请求：

{
  "jsonrpc": "2.0",
  "id": 3,
  "method": "resources/templates/list"
}

响应：

{
  "jsonrpc": "2.0",
  "id": 3,
  "result": {
    "resourceTemplates": [
      {
        "uriTemplate": "file:///{path}",
        "name": "项目文件",
        "description": "访问项目目录中的文件",
        "mimeType": "application/octet-stream"
      }
    ]
  }
}

列表更改通知

当可用资源列表更改时，声明了 listChanged 能力的服务器应该发送通知：

{
  "jsonrpc": "2.0",
  "method": "notifications/resources/list_changed"
}

订阅

协议支持可选的资源更改订阅。客户端可以订阅特定资源并在其更改时接收通知：

订阅请求：

{
  "jsonrpc": "2.0",
  "id": 4,
  "method": "resources/subscribe",
  "params": {
    "uri": "file:///project/src/main.rs"
  }
}

更新通知：

{
  "jsonrpc": "2.0",
  "method": "notifications/resources/updated",
  "params": {
    "uri": "file:///project/src/main.rs"
  }
}

消息流程 

sequenceDiagram
    participant Client
    participant Server

    Note over Client,Server: 资源发现
    Client->>Server: resources/list
    Server-->>Client: 资源列表

    Note over Client,Server: 资源访问
    Client->>Server: resources/read
    Server-->>Client: 资源内容

    Note over Client,Server: 订阅
    Client->>Server: resources/subscribe
    Server-->>Client: 订阅确认

    Note over Client,Server: 更新
    Server--)Client: notifications/resources/updated
    Client->>Server: resources/read
    Server-->>Client: 更新的内容

数据类型

资源

资源定义包括：

  • uri：资源的唯一标识符
  • name：人类可读名称
  • description：可选描述
  • mimeType：可选 MIME 类型

资源内容

资源可以包含文本或二进制数据：

文本内容 

{
  "uri": "file:///example.txt",
  "mimeType": "text/plain",
  "text": "资源内容"
}

二进制内容 

{
  "uri": "file:///example.png",
  "mimeType": "image/png",
  "blob": "base64编码数据"
}

常见 URI 方案

协议定义了几种标准 URI 方案。此列表并非详尽无遗—实现始终可以自由使用额外的自定义 URI 方案。

https://

用于表示在网络上可用的资源。

服务器应该仅在客户端能够自行从网络直接获取和加载资源时使用此方案—也就是说，它不需要通过 MCP 服务器读取资源。

对于其他用例，服务器应该优先使用另一个 URI 方案，或定义一个自定义方案，即使服务器自己将通过互联网下载资源内容。

file://

用于标识表现为文件系统的资源。但是，资源不需要映射到实际的物理文件系统。

MCP 服务器可以使用XDG MIME 类型（如 inode/directory）标识 file:// 资源，以表示没有标准 MIME 类型的非常规文件（如目录）。

git://

Git 版本控制集成。

错误处理

服务器应该为常见的失败情况返回标准 JSON-RPC 错误：

  • 未找到资源：-32002
  • 内部错误：-32603

错误示例：

{
  "jsonrpc": "2.0",
  "id": 5,
  "error": {
    "code": -32002,
    "message": "未找到资源",
    "data": {
      "uri": "file:///nonexistent.txt"
    }
  }
}

安全考虑

  1. 服务器必须验证所有资源 URI
  2. 应该为敏感资源实现访问控制
  3. 二进制数据必须被正确编码
  4. 在操作前应该检查资源权限
提示工具