Skip to main content
Glama

Xonta MAX

max_api_reference

Read-onlyIdempotent

Look up current facts about the MAX Bot API and Mini Apps (MAX Bridge) with links to dev.max.ru.

Covers base URL and auth, the Russian Trusted Root CA, advertising in MAX (topic 'ads'), webhooks vs long polling, sending messages, inline keyboards and callbacks, formatting, uploads, chat tracking without GET /chats, mini-apps, initData validation, deep links, who may create bots, official libraries. Language models usually know an outdated API (platform-api.max.ru, token in query, GET /chats) — use this before writing MAX code. With no arguments returns the list of topics.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "max_api_reference"
  }
}

Input Schema

NameRequiredDescriptionDefault
langNoAnswer language: 'en' English, 'ru' Russian. Pick the user's language; default ru (or XONTA_MAX_LANG)
queryNoFree text in English or Russian, e.g. 'webhook certificate', 'callback answer', 'initData', 'GET /chats', 'attachment.not.ready'
topicNoReturn one whole topic instead of searching

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.3/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already declare readOnly, idempotent, non-destructive, and closed-world, so safety is covered; the description adds that an empty call returns the topic list and that responses include links to dev.max.ru. It doesn't discuss freshness guarantees or the shape of returned facts, but for a read-only reference lookup that is a minor gap.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Front-loaded with the core purpose, followed by a compact coverage list and the 'before writing MAX code' rationale. The topic enumeration is long but each item maps to real retrievable content, so it earns its space; a slightly tighter grouping would improve scanability.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a read-only, three-parameter, no-output-schema reference tool, the definition tells the agent what it can retrieve, how to list topics, and why to call it before generating code. Only the interaction between query and topic and the response shape remain unstated.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, so the baseline is 3; the description earns an extra point by enumerating the subject areas (auth, TLS/CA, ads, webhooks vs long polling, keyboards, initData, deep links, libraries) that effectively explain what the topic enum values mean. It does not explain how query and topic interact when both are supplied.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb and resource ('Look up current facts about the MAX Bot API and Mini Apps') and then enumerates the covered domains, so an agent knows exactly what knowledge is retrievable. It also distinguishes itself from generic model knowledge by naming the outdated assumptions (platform-api.max.ru, token in query, GET /chats) it corrects.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Explicitly prescribes the timing: 'use this before writing MAX code' because models usually know an outdated API. It also documents the zero-argument behavior (returns the topic list), which tells the agent how to start. It stops short of naming sibling tools or stating when another tool (e.g. an endpoint or limits tool) should be preferred.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.