← Документация для агентов / docs-for-agents

Документация для агентов

ИИ-агенты, такие как Cursor, GitHub Copilot и Claude Code, умеют отвечать на вопросы о продуктах Cloudflare, генерировать конфигурацию и вызывать API Cloudflare от вашего имени. Документация Cloudflare предоставляет контент в удобных для агентов форматах, agent skills и MCP-серверы, чтобы ваш ИИ-агент мог искать нужную информацию в документации и напрямую взаимодействовать с сервисами Cloudflare.

На этой странице описаны доступные подходы и порядок их настройки.

Эти материалы охватывают разные аспекты использования ИИ-агентов с документацией Cloudflare. Начните с того, который наиболее актуален для вас:

Agent skills ↗ представляют собой структурированные, специализированные для конкретных задач инструкции, которые ИИ-инструменты загружают по требованию. Например, skill может научить вашего агента развертывать Cloudflare Worker или настраивать правило WAF (Web Application Firewall). Skills дают агенту специфичные для Cloudflare инструкции, которых у него иначе не было бы. Cloudflare публикует skills для Workers, хранилища, ИИ, сети, безопасности и других направлений в репозиторий Cloudflare Skills ↗.

У каждого агента свой способ установки skills. Подробности приведены в Настройка агента с инструкциями по установке.

Model Context Protocol ↗ (MCP) представляет собой открытый стандарт, определяющий, как ИИ-инструменты подключаются к внешним инструментам, данным и сервисам. MCP-сервер представляет собой приложение, которое предоставляет определенные возможности. Когда вы подключаете такой сервер к своему агенту, агент может использовать эти возможности в рамках своей работы (например, для поиска по документации, создания записей DNS или развертывания Workers).

Cloudflare предоставляет управляемые удаленные MCP-серверы, которые дают вашему агенту возможность искать информацию в документации, вызывать API Cloudflare и запрашивать логи и аналитику прямо в процессе работы.

Есть два подхода:

• Cloudflare API MCP server: сервер Code Mode, который охватывает весь API Cloudflare (более 2,500 конечных точек). Используйте его, если вашему агенту нужен широкий доступ сразу к нескольким продуктам Cloudflare.
• Специализированные серверы для отдельных областей: специализированные серверы для документации, наблюдаемости, аналитики DNS и других задач. Используйте их, если вашему агенту нужен доступ только к определенной области. Полный каталог приведен в cloudflare/mcp-server-cloudflare ↗ репозиторий.

Руководство Настройка агента включает установку MCP-сервера в составе раздела Quick start. Полный список доступных MCP-серверов приведен в MCP серверы для Cloudflare.

ИИ-агенты используют большие языковые модели (LLM) для понимания ваших запросов и генерации ответов. Модель влияет на качество, скорость и стоимость ответов. Количество доступных для выбора моделей зависит от конкретного агента:

• Заблокировано: поддерживаются только модели самого поставщика.
• BYOK (Bring Your Own Key): вы указываете собственный ключ API для выбранного поставщика модели.
• Несколько поставщиков: из коробки поддерживается несколько поставщиков моделей.

То, как агент сохраняет информацию о вашем проекте между беседами, определяет, сколько агент будет помнить между сессиями:

• Память проекта: агент запоминает контекст между сессиями с помощью сохраненных файлов или памяти.
• Индексированная кодовая база: агент строит индекс вашего репозитория с возможностью поиска для быстрого доступа к данным.

Для каждого поддерживаемого агента есть отдельное руководство по настройке, которое охватывает установку, skills, настройку MCP-сервера, примеры запросов, советы и решение проблем.

ИИ-инструменты работают лучше с Markdown, чем с HTML, потому что явная структура Markdown создает меньше накладных расходов, чем теги HTML. Это снижает количество напрасно расходуемых токенов (единиц текста, которые обрабатывает ИИ-модель) и дает более качественные результаты.

Каждая страница документации доступна в формате Markdown с помощью любого из следующих способов на основе Markdown for Agents.

На любой странице документации выберите Copy as Markdown чтобы скопировать текущую страницу в формате Markdown.

Добавить /index.md в конец URL-адреса любой страницы. Например:

https://developers.cloudflare.com/workers/get-started/index.md

Запросите любую страницу с помощью Accept: text/markdown заголовок, который сообщает серверу, что вы предпочитаете Markdown вместо HTML:

curl "https://developers.cloudflare.com/workers/get-started/" \
  --header "Accept: text/markdown"

Ответ включает x-markdown-tokens и x-original-tokens заголовки с приблизительным количеством токенов для документа в формате Markdown и исходного документа в формате HTML. Это полезно для планирования размера контекстного окна (контекстным окном называется максимальное количество токенов, которое ИИ-модель может учитывать одновременно).

Эти конечные точки соответствуют стандарт llms.txt ↗ и предоставляют содержимое документации в формате Markdown:

У каждого продукта есть собственная специализированная llms.txt и llms-full.txt. Используйте их, если вам нужна документация только по конкретному продукту.

Замените /workers/ с любым путем к продукту. Полный список доступных продуктов приведен в /llms.txt.

Одна Спецификация OpenAPI ↗ представляет собой машиночитаемое описание API: в нем перечислены все доступные конечные точки, параметры, которые принимает каждая из них, и возвращаемые ответы. Если добавить это описание в контекст вашего ИИ-инструмента, инструмент сможет генерировать вызовы API к сервисам Cloudflare без необходимости вручную искать нужную информацию в документации.

Полная спецификация OpenAPI для API Cloudflare доступна для ИИ-инструментов написания кода, клиентов API и генераторов кода:

Полное описание API приведено в Документация по API Cloudflare.