Skip to main content
Glama

Server Configuration

Describes the environment variables required to run the server.

NameRequiredDescriptionDefault

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

CapabilityDetails
tools
{
  "listChanged": true
}
prompts
{
  "listChanged": true
}
resources
{
  "listChanged": true
}
completions
{}

Tools

Functions exposed to the LLM to take actions

NameDescription
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

NameDescription
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

NameDescription
overviewОбзор MAX Bot API: авторизация, base URL, лимиты, статус-коды
api-botGET /me — информация о боте
api-chatsЭндпоинты управления чатами
api-pinned-messagesЗакрепление/открепление сообщений
api-membersУправление участниками чатов
api-messagesОтправка, редактирование, удаление сообщений
api-subscriptionsWebhook-подписки и 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Кнопка встроенной клавиатуры.
SubscriptionWebhook-подписка бота. Отдельная 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Флекс-контейнер.
GridGrid-контейнер.

Latest Blog Posts

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