max-docs
Click on "Install Server".
Wait a few minutes for the server to deploy. Once ready, it will show a "Started" state.
In the chat, type
@followed by the MCP server name and your instructions, e.g., "@max-docsfind docs for the sendMessage endpoint"
That's it! The server will respond to your query, and you can continue using it as needed.
Here is a step-by-step guide with screenshots.
MAX Platform Docs MCP Server
MCP-сервер с локальной документацией по MAX Platform для AI-кодинг-агентов. После сборки сервер отдаёт документацию через stdio и покрывает не только MAX Bot API, но и руководства, mini apps / MAX Bridge API и библиотеку UI-компонентов.
Что покрывает проект
29 эндпоинтов MAX Bot API
26 моделей данных
20 руководств в 8 категориях
MAX Bridge API для мини-приложений: 6 объектов и 17 событий
35 UI-компонентов MAX UI
8 MCP tools (поиск с фильтрами, примеры кода, endpoint lookup)
4 MCP prompts (создание бота, паттерны сообщений, мини-приложения, диагностика)
Расширенный набор resources с автодополнением
Related MCP server: MCP Framework Documentation Server
Требования
Node.js
>= 18npm
>= 8
Проверка:
node --version
npm --versionУстановка и сборка
git clone https://github.com/Launchery/max_docs_mcp.git
cd max_docs_mcp
npm install
npm run buildТочка входа после сборки: dist/index.js.
Для локального запуска из корня репозитория уже есть пример в ./.mcp.json.
Быстрый старт
git clone https://github.com/Launchery/max_docs_mcp.git
cd max_docs_mcp
npm install
npm run build
echo "$(pwd)/dist/index.js"Дальше подключите этот путь к вашему MCP-клиенту как stdio-сервер:
{
"mcpServers": {
"max-docs": {
"command": "node",
"args": ["/absolute/path/to/max_docs_mcp/dist/index.js"]
}
}
}Подключение к клиентам
Сервер использует stdio, поэтому схема везде одна и та же: клиент запускает node <path>/dist/index.js как дочерний процесс.
Claude Code
claude mcp add --scope user max-docs -- node "/absolute/path/to/max_docs_mcp/dist/index.js"Проверка в сессии:
/mcpClaude Desktop
Добавьте блок mcpServers.max-docs в claude_desktop_config.json:
{
"mcpServers": {
"max-docs": {
"command": "node",
"args": ["/absolute/path/to/max_docs_mcp/dist/index.js"]
}
}
}Cursor
Создайте .cursor/mcp.json в рабочем проекте:
{
"mcpServers": {
"max-docs": {
"command": "node",
"args": ["/absolute/path/to/max_docs_mcp/dist/index.js"]
}
}
}Windsurf
Добавьте тот же stdio-сервер в mcp_config.json:
{
"mcpServers": {
"max-docs": {
"command": "node",
"args": ["/absolute/path/to/max_docs_mcp/dist/index.js"]
}
}
}VS Code + Continue
mcpServers:
- name: max-docs
command: node
args:
- /absolute/path/to/max_docs_mcp/dist/index.jsOpenAI Codex CLI
{
"mcpServers": {
"max-docs": {
"command": "node",
"args": ["/absolute/path/to/max_docs_mcp/dist/index.js"]
}
}
}Или через флаг:
codex --mcp-config '{"max-docs":{"command":"node","args":["/absolute/path/to/max_docs_mcp/dist/index.js"]}}'OpenCode CLI
[mcp.max-docs]
type = "stdio"
command = "node"
args = ["/absolute/path/to/max_docs_mcp/dist/index.js"]Demo
Для быстрой записи GIF / скринкаста / терминального демо см. DEMO-SCRIPT.md.
Короткая версия demo path:
npm install && npm run buildпоказать MCP config с
max-docsпоказать успешный
initializeпоказать
tools/callдляlist_guidesилиsearch_docs
Проверка работоспособности
Сборка:
npm run buildПрямой запуск:
npm startСервер должен запуститься и ждать JSON-RPC сообщения по stdin.
Проверка initialize вручную:
echo '{"jsonrpc":"2.0","id":1,"method":"initialize","params":{"protocolVersion":"2024-11-05","capabilities":{},"clientInfo":{"name":"test","version":"1.0.0"}}}' | node dist/index.jsВ ответе должны быть:
"name": "max-docs""version": "2.0.0"
Проверка tool-вызова вручную:
printf '{"jsonrpc":"2.0","id":1,"method":"initialize","params":{"protocolVersion":"2024-11-05","capabilities":{},"clientInfo":{"name":"test","version":"1.0.0"}}}\n{"jsonrpc":"2.0","method":"notifications/initialized"}\n{"jsonrpc":"2.0","id":2,"method":"tools/call","params":{"name":"list_guides","arguments":{}}}\n' | node dist/index.js 2>/dev/nullДоступные tools
Сервер регистрирует 7 инструментов.
Tool | Аргументы | Что возвращает |
| нет | Таблицу всех 29 эндпоинтов MAX Bot API |
|
| Полную документацию конкретного эндпоинта |
|
| Поиск по endpoint-ам, моделям, guide-ам, Bridge API и UI-компонентам |
|
| Список всех guide-ов или guide-ов выбранной категории |
|
| Полный текст guide-а по ID |
|
| Обзор MAX Bridge API, объект Bridge API или список событий |
|
| Обзор MAX UI или описание конкретного компонента |
Категории для list_guides
platformchatbottutorialssdkmini-appschannelspartnerslegal
Доступные guide ID
connection-guide
service-selection
bot-creation
nocode-bot-creation
bot-management
bot-coding-preparation
hello-bot-javascript
hello-bot-go
sdk-javascript
sdk-go
channel-creation
channel-management
partner-integration
legal-rules
legal-requirements
legal-agreement
legal-privacy
bridge-api
mini-apps-introduction
data-validationДоступные Bridge API объекты
BackButton
ScreenCapture
HapticFeedback
BiometricManager
DeviceStorage
SecureStorage
eventsПримеры компонентов для get_component
Button
Input
Avatar.Container
Flex
Typography.Title
ProfileДоступные resources
API и модели
max-docs://overviewmax-docs://api/botmax-docs://api/chatsmax-docs://api/pinned-messagesmax-docs://api/membersmax-docs://api/messagesmax-docs://api/subscriptionsmax-docs://api/uploadsmax-docs://api/callbacksmax-docs://modelsmax-docs://models/{name}
Руководства
max-docs://guidesmax-docs://guides/platformmax-docs://guides/chatbotmax-docs://guides/tutorialsmax-docs://guides/sdkmax-docs://guides/mini-appsmax-docs://guides/channelsmax-docs://guides/partnersmax-docs://guides/legalmax-docs://guides/{id}
Mini apps / Bridge API
max-docs://mini-appsmax-docs://mini-apps/bridge-apimax-docs://mini-apps/bridge-api/eventsmax-docs://mini-apps/bridge-api/{name}
UI components
max-docs://ui-componentsmax-docs://ui-components/{name}
Примеры запросов к агенту
Покажи все эндпоинты MAX Bot API и объясни, какой использовать для отправки сообщения.Используй документацию MAX и покажи guide по созданию чат-бота.Какие события есть у MAX Bridge API и как слушать кнопку "назад"?Найди в MAX UI компонент Button и покажи его параметры.Подскажи, как валидировать данные мини-приложения в MAX.Структура проекта
max_docs_mcp/
├── .mcp.json
├── README.md
├── package.json
├── tsconfig.json
├── src/
│ ├── index.ts
│ ├── server.ts
│ ├── data/
│ │ ├── overview.ts
│ │ ├── types.ts
│ │ ├── endpoints/
│ │ ├── models/
│ │ ├── guides/
│ │ ├── mini-apps/
│ │ └── ui-components/
│ ├── resources/
│ │ └── registry.ts
│ ├── tools/
│ │ ├── list-endpoints.ts
│ │ ├── get-endpoint.ts
│ │ ├── search-docs.ts
│ │ ├── list-guides.ts
│ │ ├── get-guide.ts
│ │ ├── get-bridge-api.ts
│ │ └── get-component.ts
│ └── utils/
│ ├── formatter.ts
│ └── search.ts
└── dist/Разработка
Режимы работы:
npm run build
npm run dev
npm startЕсли вы добавляете новую документацию:
Обновите соответствующий файл в
src/data/...Добавьте экспорт в нужный
index.tsЕсли появляется новый MCP tool или resource, зарегистрируйте его в
src/server.tsилиsrc/resources/registry.tsПересоберите проект через
npm run build
Устранение неполадок
Сервер не запускается
npm run build
node dist/index.jsЕсли процесс не падает сразу, сервер стартует корректно и ждёт stdin.
Клиент не видит MCP-сервер
Проверьте, что указан абсолютный путь к
dist/index.jsПересоберите проект:
npm run buildПерезапустите MCP-клиент после изменения конфигурации
Для Claude Code проверьте
/mcp
Документация выглядит старой
git pull
npm install
npm run buildОшибка Cannot find module
Переустановите зависимости и пересоберите проект:
rm -rf node_modules dist
npm install
npm run buildMCP Registry
Сервер подготовлен для submission в MCP Registry. Файл server.json содержит метаданные для публикации.
# После npm publish
# Submit to MCP Registry (requires GitHub auth)
curl -X POST https://registry.modelcontextprotocol.io/v0/publish \
-H "Authorization: Bearer $MCP_REGISTRY_TOKEN" \
-H "Content-Type: application/json" \
--data @server.jsonThis server cannot be installed
Maintenance
Resources
Unclaimed servers have limited discoverability.
Looking for Admin?
If you are the server author, to access and configure the admin panel.
Latest Blog Posts
- 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