docs: publish translated docs in twelve languages and the tool that maintains them (#3280)

This commit is contained in:
Max 2026-08-14 17:07:34 +01:00 • committed by GitHub
commit 52ad0a8876
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -0,0 +1,156 @@
---
translation:
sections: [d65c098f37f5b6c3, dd0c2724d6f2877e, 6835bb3570c6714c, ffe823cb0fedd488, f33651add1b59094]
tool: 1
---
# Промпты {#prompts}
**Промпт** — это шаблон сообщения, который выбирает пользователь.
Инструменты предназначены для модели. Промпт — наоборот: пользователь выбирает его из меню в своём клиенте (слэш-команда, кнопка), заполняет аргументы, и отрендеренные сообщения попадают в диалог так, будто он набрал их сам.
Чтобы объявить промпт, поставьте `@mcp.prompt()` над функцией, которая возвращает текст.
## Первый промпт {#your-first-prompt}
```python title="server.py" hl_lines="6-9"
--8<-- "docs_src/prompts/tutorial001.py"
```
SDK читает те же три вещи, что и у инструмента:
* **Имя** — это имя функции: `review_code`.
* **Описание**, которое показывает клиент, — это строка документации: `Review a piece of code.`
* **Аргументы** берутся из параметров. У `code` нет значения по умолчанию, поэтому он обязательный.
Вот что клиент получает в ответ на `prompts/list`:
```json
{
"name": "review_code",
"description": "Review a piece of code.",
"arguments": [
{"name": "code", "required": true}
]
}
```
Никакой JSON Schema здесь нет. Аргументы промпта — это плоский список **именованных строковых значений**: форма, которую заполняет человек, а не полезная нагрузка, которую конструирует модель.
### Рендеринг {#rendering-it}
Клиент рендерит шаблон через `prompts/get`, передавая аргументы. Функция выполняется, и возвращённая `str` становится **одним сообщением пользователя**:
```json
{
"description": "Review a piece of code.",
"messages": [
{
"role": "user",
"content": {
"type": "text",
"text": "Please review this code:\n\ndef add(a, b): return a + b"
}
}
],
"resultType": "complete"
}
```
Вот и вся жизнь промпта: перечислен по имени, отрендерен по запросу, отправлен в чат.
!!! check
`required` проверяется до запуска функции. Попробуйте отрендерить `review_code` без `code` —
сам запрос завершится ошибкой JSON-RPC (код `-32603`):
```text
mcp.shared.exceptions.MCPError: Internal server error
```
Результата с ошибкой в стиле инструмента, который можно было бы вернуть модели, нет, потому что
модели в этой цепочке нет: вызов выбрасывает исключение. Причина (`Missing required arguments: {'code'}`)
попадает в лог сервера.
### Попробуйте сами {#try-it}
Запустите сервер с MCP Inspector:
```console
uv run mcp dev server.py
```
Откройте вкладку **Prompts** и выберите `review_code`. Inspector нарисует форму с одним обязательным полем `code`. Заполните его, отрендерите — и в ответ придёт ровно то сообщение пользователя, что показано выше.
## Больше одного сообщения {#more-than-one-message}
Ревью кода — это одно сообщение. Сессия отладки — это диалог, и промпт может задать его целиком.
Верните список сообщений вместо `str`:
```python title="server.py" hl_lines="2 13-20"
--8<-- "docs_src/prompts/tutorial002.py"
```
* `UserMessage` и `AssistantMessage` находятся в `mcp.server.mcpserver.prompts.base`. Передайте им `str`, и они сами обернут её в `TextContent`. Роль — это имя класса.
* `Message` — их общий базовый класс. Используйте его как аннотацию возвращаемого типа.
Теперь `debug_error` при рендеринге даёт три сообщения по порядку:
```json
{
"description": "Start a debugging conversation.",
"messages": [
{"role": "user", "content": {"type": "text", "text": "I'm seeing this error:"}},
{"role": "user", "content": {"type": "text", "text": "TypeError: 'int' object is not iterable"}},
{
"role": "assistant",
"content": {"type": "text", "text": "I'll help debug that. What have you tried so far?"}
}
],
"resultType": "complete"
}
```
Обратите внимание на последнее. Заранее заполненная реплика `assistant` — это способ направить *следующий* ответ модели, не заставляя пользователя набирать эти указания самостоятельно.
## Заголовки и описания аргументов {#titles-and-argument-descriptions}
`review_code` — имя функции, а не подпись. Дайте клиенту что-нибудь получше для надписи на кнопке и опишите каждый аргумент, чтобы форма была понятна сама по себе:
```python title="server.py" hl_lines="10-13"
--8<-- "docs_src/prompts/tutorial003.py"
```
* `title="Code review"` — человекочитаемое имя, ровно как `title` у инструмента.
* `Annotated[str, Field(description=...)]` — тот же приём, которым **[Инструменты](tools.md)** описывают параметры инструмента. Здесь описание попадает в аргумент, а не в схему.
* У `language` есть значение по умолчанию, поэтому он перестаёт быть обязательным.
Запись в `prompts/list` теперь содержит всё, что нужно клиенту, чтобы нарисовать хорошую форму:
```json
{
"name": "review_code",
"title": "Code review",
"description": "Review a piece of code.",
"arguments": [
{"name": "code", "description": "The code to review.", "required": true},
{"name": "language", "description": "The language the code is written in.", "required": false}
]
}
```
!!! info
Если вы читали страницу **[Инструменты](tools.md)**, то уже знаете всё, что здесь написано. Тот же декоратор,
та же строка документации в роли описания, те же `Annotated`/`Field`. Меняется только то, кто
запускает промпт (пользователь) и куда идёт результат (в диалог).
## Итоги {#recap}
* `@mcp.prompt()` над функцией делает её промптом. Имя — из функции, описание — из строки документации.
* Промпты **управляются пользователем**: клиент их перечисляет, пользователь выбирает один и заполняет аргументы.
* Аргументы — плоский список именованных строк (без схемы). Параметр со значением по умолчанию необязателен.
* Верните `str` — и она станет одним сообщением пользователя. Верните список `UserMessage` / `AssistantMessage`, чтобы задать многоходовой диалог.
* `title=` и `Field(description=...)` — это то, что клиент показывает в интерфейсе.
* Отсутствующий обязательный аргумент проваливает весь запрос. Отдельного результата с ошибкой у промпта нет.
Автодополнение аргументов промпта (или шаблона ресурса) на стороне сервера — на странице **[Автодополнение](completions.md)**.