max-docs
Click on "Deploy 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-docs find 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.jsonAvailable Tools
8 toolsget_bridge_apiA
Документация MAX Bridge API (window.WebApp) для мини-приложений. Без параметров — обзор. С параметром — конкретный объект (BackButton, HapticFeedback и др.) или "events" для списка событий.
Inputs: object.
get_code_exampleB
Получить пример кода для типичной задачи MAX Bot API. Доступно: send-message, send-buttons, handle-callback, webhook-setup, mini-app-init, upload-file, bridge-storage, error-handling.
Inputs: task (required).
get_componentA
Документация MAX UI компонентов. Без параметров — обзор библиотеки. С параметром — конкретный компонент (Button, Input, Avatar.Container и др.).
Inputs: name.
get_endpointA
Возвращает полную документацию конкретного эндпоинта MAX Bot API по методу и пути
Inputs: path (required), method (required).
get_guideA
Возвращает полное руководство по ID. Используйте list_guides для просмотра доступных ID.
Inputs: id (required).
list_endpointsA
Возвращает таблицу всех эндпоинтов MAX Bot API с методом, путём и описанием
Inputs: no named parameters.
list_guidesA
Список всех руководств документации MAX: платформа, создание ботов, SDK, мини-приложения, каналы, партнёры, юридические документы
Inputs: category.
search_docsA
Поиск по всей документации MAX: эндпоинты, модели, руководства, Bridge API, UI-компоненты. Поддерживает фильтрацию по типу и категории.
Inputs: query (required), type, category.
Tool Schema Changelog
Recent tool additions, removals, and schema changes observed during successful MCP inspections.
Loading tool schema changelog…
TDQS
Scored across 8 tools
Each tool targets a distinct documentation aspect: endpoints, guides, bridge API, components, code examples, and general search. No two tools overlap in purpose; even get_bridge_api and get_component use parameters to switch between overview and detail, avoiding duplicate tools.
All tool names follow a consistent verb_noun snake_case pattern: list_endpoints, get_endpoint, search_docs, list_guides, get_guide, get_bridge_api, get_component, get_code_example. The verbs 'list', 'get', and 'search' are used predictably according to the action.
8 tools is well-scoped for a documentation server. Each tool covers a necessary function without redundancy, providing a comprehensive but manageable set for users to explore MAX documentation.
The server covers the full lifecycle of documentation access: listing endpoints, retrieving endpoint details, searching across all docs, listing guides, retrieving guides, accessing Bridge API docs, component docs, and code examples. No obvious gaps exist for the stated purpose.
Maintenance
Related MCP Connectors
Build and run AI workflows, agents, data tables and 1000+ API integrations from any MCP client.
Email inboxes, webhook URLs, mock APIs and 170+ tools for coding agents over one MCP connection.
AI agent platform: manage leads, conversations, bots, calendar and CRM via MCP.
Automate 1,000+ services from any MCP-compatible AI agent: build Applets, run actions and queries.
Related MCP Servers
- FlicenseNot gradedqualityNot gradedmaintenanceProvides LLM-agnostic access to API documentation through MCP and REST endpoints, enabling AI assistants to retrieve, search, and proxy requests to whitelisted APIs across multiple platforms.-
- AlicenseAqualityDmaintenanceProvides tools for AI agents to search, browse, and retrieve the full documentation for the mcp-framework. It enables agents to access documentation sections and page content directly within MCP-compatible environments like Claude Code and Cursor.3MIT

@prosodyai/mcp-docsofficial
AlicenseAqualityBmaintenanceExposes ProsodyAI documentation, SDK references, REST API reference (OpenAPI), and curated implementation recipes to AI coding agents via MCP tools and resources.8MIT- FlicenseNot gradedqualityDmaintenanceGive your AI agents instant access to Keboola API documentation. Search endpoints, get parameter details, and generate curl examples—all through MCP tools.-