> ## Documentation Index
> Fetch the complete documentation index at: https://mcp.transdocs.org/llms.txt
> Use this file to discover all available pages before exploring further.
# 提示模板
**协议版本**: 2025-03-26
模型上下文协议（MCP）为服务器向客户端公开提示模板提供了标准化方式。提示模板允许服务器提供结构化的消息和与语言模型交互的指令。客户端可以发现可用的提示模板、检索其内容，并提供参数进行自定义。
## 用户交互模型
提示模板的设计是**由用户控制的**，意味着它们从服务器暴露给客户端，目的是让用户能够显式地选择并使用它们。
通常，提示模板会通过用户界面中的用户发起的命令触发，这允许用户自然地发现和调用可用的提示。
例如，作为斜杠命令：
然而，实现者可以自由选择适合其需求的任何界面模式来暴露提示——协议本身不强制要求特定的用户交互模型。
## 能力声明
支持提示的服务器**必须**在[初始化](/specification/2025-03-26/basic/lifecycle#initialization)期间声明 `prompts` 能力：
```json theme={null}
{
"capabilities": {
"prompts": {
"listChanged": true
}
}
}
```
`listChanged` 表示服务器是否会在可用提示列表发生变化时发送通知。
## 协议消息
### 列出提示
要检索可用提示，客户端发送 `prompts/list` 请求。此操作支持[分页](/specification/2025-03-26/server/utilities/pagination)。
**请求：**
```json theme={null}
{
"jsonrpc": "2.0",
"id": 1,
"method": "prompts/list",
"params": {
"cursor": "可选的游标值"
}
}
```
**响应：**
```json theme={null}
{
"jsonrpc": "2.0",
"id": 1,
"result": {
"prompts": [
{
"name": "code_review",
"description": "要求LLM分析代码质量并提出改进建议",
"arguments": [
{
"name": "code",
"description": "要审查的代码",
"required": true
}
]
}
],
"nextCursor": "下一页游标"
}
}
```
### 获取提示
要检索特定提示，客户端发送 `prompts/get` 请求。参数可以通过[补全API](/specification/2025-03-26/server/utilities/completion)自动补全。
**请求：**
```json theme={null}
{
"jsonrpc": "2.0",
"id": 2,
"method": "prompts/get",
"params": {
"name": "code_review",
"arguments": {
"code": "def hello():\n print('world')"
}
}
}
```
**响应：**
```json theme={null}
{
"jsonrpc": "2.0",
"id": 2,
"result": {
"description": "代码审查提示",
"messages": [
{
"role": "user",
"content": {
"type": "text",
"text": "请审查这段Python代码:\ndef hello():\n print('world')"
}
}
]
}
}
```
### 列表变化通知
当可用提示列表发生变化时，声明了 `listChanged` 能力的服务器**应该**发送通知：
```json theme={null}
{
"jsonrpc": "2.0",
"method": "notifications/prompts/list_changed"
}
```
## 消息流
```mermaid theme={null}
sequenceDiagram
participant Client
participant Server
Note over Client,Server: 发现
Client->>Server: prompts/list
Server-->>Client: 提示列表
Note over Client,Server: 使用
Client->>Server: prompts/get
Server-->>Client: 提示内容
opt listChanged
Note over Client,Server: 变化
Server--)Client: prompts/list_changed
Client->>Server: prompts/list
Server-->>Client: 更新后的提示
end
```
## 数据类型
### Prompt（提示）
一个提示定义包括：
* `name`：提示的唯一标识符
* `description`：可选的、面向用户的描述
* `arguments`：用于自定义的可选参数列表
### PromptMessage（提示消息）
提示中的消息可以包含：
* `role`：表示说话者的角色，可以是 "user" 或 "assistant"
* `content`：以下内容类型之一：
#### 文本内容
文本内容表示普通文本消息：
```json theme={null}
{
"type": "text",
"text": "消息的文本内容"
}
```
这是用于自然语言交互的最常见内容类型。
#### 图像内容
图像内容允许在消息中包含视觉信息：
```json theme={null}
{
"type": "image",
"data": "base64编码的图像数据",
"mimeType": "image/png"
}
```
图像数据**必须**为base64编码，并包含有效的MIME类型。这支持在需要视觉上下文时的多模态交互。
#### 音频内容
音频内容允许在消息中包含音频信息：
```json theme={null}
{
"type": "audio",
"data": "base64编码的音频数据",
"mimeType": "audio/wav"
}
```
音频数据**必须**为base64编码，并包含有效的MIME类型。这支持在需要音频上下文时的多模态交互。
#### 嵌入资源
嵌入资源允许在消息中直接引用服务器端资源：
```json theme={null}
{
"type": "resource",
"resource": {
"uri": "resource://example",
"mimeType": "text/plain",
"text": "资源内容"
}
}
```
资源可以包含文本或二进制（blob）数据，并**必须**包含：
* 有效的资源URI
* 合适的MIME类型
* 文本内容或base64编码的二进制数据
嵌入资源使提示能够无缝地将服务器管理的内容（如文档、代码示例或其他参考资料）直接整合到对话流程中。
## 错误处理
服务器**应该**为常见的失败情况返回标准JSON-RPC错误：
* 无效的提示名称：`-32602`（参数无效）
* 缺少必填参数：`-32602`（参数无效）
* 内部错误：`-32603`（内部错误）
## 实现注意事项
1. 服务器**应该**在处理前验证提示参数
2. 客户端**应该**处理大量提示列表的分页
3. 双方**应该**遵守能力协商
## 安全性
实现**必须**仔细验证所有提示的输入和输出，以防止注入攻击或对资源的未授权访问。