max-docs
Server Configuration
Describes the environment variables required to run the server.
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
Instructions
Guidance the server publishes about itself, which clients place ahead of the tool catalog so the model reads it before choosing anything.
This server publishes no instructions, or was last inspected before Glama recorded them.
Capabilities
Features and capabilities supported by this server
Protocol revision2025-11-25
| Capability | Details |
|---|---|
| tools | {
"listChanged": true
} |
| prompts | {
"listChanged": true
} |
| resources | {
"listChanged": true
} |
| completions | {} |
Tools
Functions exposed to the LLM to take actions
| Name | Description |
|---|---|
| list_endpointsA | Возвращает таблицу всех эндпоинтов MAX Bot API с методом, путём и описанием |
| get_endpointA | Возвращает полную документацию конкретного эндпоинта MAX Bot API по методу и пути |
| search_docsA | Поиск по всей документации MAX: эндпоинты, модели, руководства, Bridge API, UI-компоненты. Поддерживает фильтрацию по типу и категории. |
| list_guidesA | Список всех руководств документации MAX: платформа, создание ботов, SDK, мини-приложения, каналы, партнёры, юридические документы |
| get_guideA | Возвращает полное руководство по ID. Используйте list_guides для просмотра доступных ID. |
| get_bridge_apiA | Документация MAX Bridge API (window.WebApp) для мини-приложений. Без параметров — обзор. С параметром — конкретный объект (BackButton, HapticFeedback и др.) или "events" для списка событий. |
| get_componentA | Документация MAX UI компонентов. Без параметров — обзор библиотеки. С параметром — конкретный компонент (Button, Input, Avatar.Container и др.). |
| get_code_exampleB | Получить пример кода для типичной задачи MAX Bot API. Доступно: send-message, send-buttons, handle-callback, webhook-setup, mini-app-init, upload-file, bridge-storage, error-handling. |
Prompts
Interactive templates invoked by user choice
| Name | Description |
|---|---|
| create-bot | Пошаговое руководство по созданию MAX чат-бота. Включает регистрацию, настройку webhook и первый ответ. |
| send-message-patterns | Все способы отправки сообщений в MAX: текст, кнопки, изображения, файлы, карусели. |
| build-mini-app | Руководство по созданию мини-приложения для MAX: Bridge API, UI компоненты, навигация. |
| debug-max-api | Диагностика ошибок MAX Bot API: статусы, коды ошибок, типичные проблемы. |
Resources
Contextual data attached and managed by the client
| Name | Description |
|---|---|
| overview | Обзор MAX Bot API: авторизация, base URL, лимиты, статус-коды |
| api-bot | GET /me — информация о боте |
| api-chats | Эндпоинты управления чатами |
| api-pinned-messages | Закрепление/открепление сообщений |
| api-members | Управление участниками чатов |
| api-messages | Отправка, редактирование, удаление сообщений |
| api-subscriptions | Webhook-подписки и long polling |
| api-uploads | Загрузка файлов |
| api-callbacks | Ответы на callback-кнопки |
| models | Обзор всех моделей данных MAX Bot API |
| guides-overview | Обзор всех руководств: платформа, боты, SDK, мини-приложения, каналы, партнёры, юридика |
| guide-platform | Подключение к платформе и выбор сервисов |
| guide-chatbot | Создание, настройка и управление чат-ботами |
| guide-tutorials | Пошаговые туториалы Hello Bot (JS, Go) |
| guide-sdk | Документация SDK: JavaScript/TypeScript и Go |
| guide-mini-apps | Подключение мини-приложений, MAX Bridge и валидация данных |
| guide-channels | Создание и управление каналами |
| guide-partners | Интеграция с партнёрскими сервисами |
| guide-legal | Правила, требования, соглашения, конфиденциальность |
| mini-apps-overview | Обзор мини-приложений MAX: введение, Bridge API, валидация данных |
| bridge-api | Полная документация MAX Bridge API (window.WebApp) |
| bridge-api-events | События MAX Bridge API |
| ui-components | Обзор библиотеки MAX UI компонентов |
| User | Базовый вариант объекта пользователя или бота без аватара и описания. |
| UserWithPhoto | Расширенный вариант User с URL аватара и описанием профиля. |
| BotCommand | Команда бота из массива `BotInfo.commands`. Публичная object-страница в docs-api доступна, но в текущем рендере сайта структура раскрыта неполностью; здесь зафиксированы поля, используемые в SDK и примерах. |
| BotInfo | Вариант UserWithPhoto, который возвращается методом `GET /me` и дополнительно содержит список команд бота. |
| Chat | Объект чата. Публичная страница docs-api в основном описывает вариант группового чата, но некоторые поля явно применяются и к диалогам. |
| Message | Сообщение в чате MAX. |
| MessageBody | Тело сообщения: текст, вложения и параметры форматирования. |
| NewMessageBody | Тело запроса для отправки или редактирования сообщения. Поля совпадают с объектом docs-api `NewMessageBody`. |
| NewMessageLink | Ссылка на сообщение при отправке нового сообщения. |
| LinkedMessage | Связанное сообщение внутри объекта Message. |
| Recipient | Получатель сообщения. |
| MessageStat | Статистика сообщения в канале. |
| Image | Изображение, используемое как иконка чата или аватар. |
| Callback | Данные callback-кнопки внутри update типа `message_callback`. Отдельная object-страница в docs-api сейчас не раскрыта, поэтому структура агрегирована по методам `GET /updates` и `POST /answers`. |
| Update | Событие, получаемое ботом через webhook или long polling. Базовая страница объекта в docs-api описывает `message_created`, а остальные поля зависят от `update_type`. |
| ChatAdminPermission | Перечень прав администратора группового чата. Используется в `ChatMember.permissions` и методах управления администраторами. |
| ChatMember | Вариант UserWithPhoto для участников чата. Возвращается методами из группы `/chats` и дополняет профиль данными о членстве. |
| Attachment | Общий контейнер вложения внутри `MessageBody.attachments`. Конкретная структура `payload` зависит от `type`. |
| AttachmentRequest | Вложение для отправки или редактирования сообщения. Отдельная object-страница в docs-api сейчас не раскрыта; структура агрегирована по `NewMessageBody`, `POST /messages`, `PUT /messages` и `POST /uploads`. |
| InlineKeyboardAttachment | Встроенная клавиатура, прикрепляемая к сообщению. Допускается не более 210 кнопок в 30 рядах. |
| PhotoAttachment | Фото-вложение в сообщении. |
| VideoAttachment | Видео-вложение в сообщении. |
| AudioAttachment | Аудио-вложение в сообщении. |
| FileAttachment | Файловое вложение в сообщении. |
| Button | Кнопка встроенной клавиатуры. |
| Subscription | Webhook-подписка бота. Отдельная object-страница в docs-api сейчас не опубликована; описание агрегировано по методам `GET /subscriptions` и `POST /subscriptions`. |
| Подключение к платформе MAX | Кто может подключиться к платформе MAX для партнёров, как создать профиль организации и пройти верификацию. |
| Выбор сервисов для интеграции | Какие сервисы можно подключить после создания и верификации организации и что появляется после модерации бота. |
| Создание чат-бота | Как создать бота на платформе MAX для партнёров, какие поля заполнить и что происходит после модерации. |
| Создание бота без кода (no-code) | Как использовать конструкторы партнёров и какие настройки бота всё равно выполняются на платформе MAX. |
| Управление чат-ботом | Редактирование карточки бота, управление токеном, настройкой групповых чатов и удалением. |
| Подготовка к разработке бота | Токен, базовые API-запросы, webhook и long polling, диплинки и повседневные операции в сценарии с разработкой. |
| Hello Bot на JavaScript | Пошаговое руководство по созданию первого бота MAX на JavaScript |
| Hello Bot на Go | Пошаговое руководство по созданию первого бота MAX на Golang |
| JavaScript/TypeScript SDK | Полная документация по библиотеке @maxhub/max-bot-api для JavaScript и TypeScript |
| Go SDK | Документация по библиотеке max-bot-api-client-go для Golang |
| Создание канала | Как создаются публичные и приватные каналы в MAX и какие из них требуют платформу MAX для партнёров. |
| Управление каналом | Настройки канала, права владельца, администраторы, приглашения и заявки на вступление. |
| Интеграция с партнёрами | Подключение чат-платформ, конструкторов ботов и CRM через токен бота после его модерации. |
| Правила размещения приложений | Структурированный обзор обязательных правил размещения чат-ботов и мини-приложений. Для юридически значимого текста приоритетен официальный документ на dev.max.ru. |
| Требования к содержанию и функциональности | Сжатое изложение обязательных требований к контенту, функциональности, безопасности и пользовательским сценариям приложений разработчиков. |
| Типовое пользовательское соглашение | Типовой шаблон условий использования приложения разработчика внутри MAX. Если у разработчика есть собственные условия, применяются они. |
| Политика конфиденциальности | Типовой шаблон политики конфиденциальности для приложений разработчиков внутри MAX. При наличии собственной политики у разработчика приоритет остаётся за ней. |
| MAX Bridge | Обзор библиотеки MAX Bridge: подключение `max-web-app.js`, объект `window.WebApp`, события и системные API для мини-приложений |
| Подключение мини-приложения | Подключение мини-приложения к боту, требования к URL, кнопке запуска и deep link `startapp` |
| Валидация данных мини-приложения | Проверка подлинности `initData` мини-приложения через HMAC-SHA256 и токен бота |
| BackButton | Управление кнопкой Назад в шапке мини-приложения |
| ScreenCapture | Управляет возможностью делать скриншоты и записывать экран |
| HapticFeedback | Тактильная обратная связь: воздействия, уведомления и изменение выбора |
| BiometricManager | Работа с биометрической аутентификацией и биометрическим токеном в защищённом хранилище устройства |
| DeviceStorage | Локальное хранилище данных, привязанное к пользователю MAX. Не поддерживается в веб-версии |
| SecureStorage | Защищённое хранилище данных. Не поддерживается в веб-версии |
| Avatar.Container | Контейнер аватара с поддержкой размеров, формы и угловых слотов. |
| Avatar.Image | Изображение аватара с fallback-элементом и fallback-градиентом. |
| Avatar.Text | Текстовый фолбэк аватара. |
| Avatar.Icon | Иконка внутри аватара. |
| Avatar.OnlineDot | Индикатор онлайн-статуса для аватара. |
| Avatar.Overlay | Оверлей для отображения дополнительного состояния поверх аватара. |
| Avatar.CloseButton | Кнопка закрытия, встроенная в аватар. |
| Button | Основная кнопка MAX UI. |
| IconButton | Кнопка-иконка с теми же режимами и appearance, что и обычная Button. |
| ToolButton | Кнопка-инструмент с иконкой и лёгким appearance. |
| CellAction | Кнопка действия в формате ячейки. |
| Input | Базовое текстовое поле ввода. |
| Textarea | Многострочное поле ввода. |
| SearchInput | Поле поиска со встроенной кнопкой очистки. |
| Switch | Переключатель. |
| CellHeader | Заголовок группы ячеек. |
| CellInput | Поле ввода в формате ячейки. |
| CellList | Контейнер для списка ячеек. |
| CellSimple | Универсальная ячейка с title/subtitle/overline и слотами по краям. |
| Counter | Счётчик/бейдж со значением. |
| Dot | Точка-индикатор. |
| Spinner | Индикатор загрузки. |
| Container | Базовый контейнер с опцией растяжения на всю ширину. |
| Flex | Флекс-контейнер. |
| Grid | Grid-контейнер. |
Latest Blog Posts
- Who's Calling? MCP Hosts Are an Identity Blind Spot (And the Spec Knows It)By Om-Shree-0709 on .mcpAgent IdentityOAuth 2.1
- Your AI Chatbot Just Exposed Your CEO's Salary to an InternBy Om-Shree-0709 on .Agent IdentityMCP SecurityOAuth Delegation
- Why MCP Servers Need Execution Sandboxing (And Why Your Current Stack Isn't Enough)By Om-Shree-0709 on .Agentic AiPrompt InjectionWebAssembly
MCP directory API
We provide all the information about MCP servers via our MCP API.
curl -X GET 'https://glama.ai/api/mcp/v1/servers/Launchery/max_docs_mcp'
If you have feedback or need assistance with the MCP directory API, please join our Discord server