Работа с документацией в LLM и агентах
Модели или агентах, которые помогают при разработке, могут отвечать на вопросы по документации GigaChat API. Для генерации корректного ответа им нужен качественный контекст — релевантная, структурированная и актуальная информация о работе сервиса.
Документация предоставляет несколько способов получить данные для формирования контекста. Комбинируйте их или используйте по отдельности в зависимости от своих з адач и возможностей доступных инструментов.
В этом разделе вы узнаете как получить доступ к исходникам документации в Markdown по ссылкам или с помощью mcp-сервера, подключенного к агенту.
Доступ ко всей документации
Для начала работы используйте файл gigachat-api-primer.md.
Он содержит краткую версию документации со всей информацией, которая нужна, чтобы быстро начать использовать API.
Передайте в LLM содержимое файла или ссылку на него, чтобы она могла ответить на вопросы о том, какие модели доступны в API, как авторизовать запросы, как использовать основные методы API и другие.
Для работы со всей документацией с помощью ИИ-помощников и агентов используйте файлы, подготовленные по стандарту llms.txt :
- файл
/gigachat/llms.txt— краткое содержание со ссылками на все разделы; - файл
/gigachat/llms-full.txt— вся документация GigaChat API (кроме спецификации) собранная в одном файле.
Запросы по отдельным разделам
Для генерации ответов по отдельному разделу используйте markdown-исходник страницы. Передайте в LLM содержимое иходника или ссылку на него, чтобы она могла ответить на вопросы по разделу.
Чтобы получить исходник:
-
Откройте раздел, по которому нужно получить ответ.
-
Выберите подходящий пункт выпадающего списка у заголовка страницы:
- Скопировать страницу — markdown-исходник страницы будет скопирован в буфер обмена;
- Открыть исходную страницу — открывает markdown-исходник страницы в новой вкладке браузера.
Использование MCP-сервера docs-mcp
Вы можете обращаться к документации GigaChat API (и других продуктов) с помощью MCP-сервера docs-mcp .
Сервер предоставляет инструменты:
list_products— доступ к списку продуктов, документация которых доступна на developers.sber.ru/docs;get_documentation— доступ к документации выбранного продкута в виде файла llms-full.txt.
Установка
Сервер распространяется в виде npm-пакета. Для установки выполните команду:
npx -y @salutejs/docs-mcp@latest
Подключение к агенту
Чтобы агент мог отвечать на вопросы по документации продукта, доступной в llms-full.txt, подключите docs-mcp в конфигурационном файле.
Пример подключения в конфигурационном файле OpenCode:
{
"$schema": "https://opencode.ai/config.json",
"mcp": {
"docs-mcp": {
"type": "local",
"command": ["npx", "-y", "@salutejs/docs-mcp@latest"],
"enabled": true,
}
}
}