Skip to main content
Glama

max_api_reference

Read-onlyIdempotent

Look up current MAX Bot API and Mini Apps facts, including auth, webhooks, messages, keyboards, uploads, and initData, to avoid outdated API details before writing MAX code.

Instructions

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 observedv0.1.0

TDQS

A4.1/5.0
Behavior3/5

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

Annotations already declare readOnlyHint, idempotentHint, destructiveHint=false, and openWorldHint=false, so the safety profile is covered. The description adds the useful behavioral fact that calling with no arguments returns the list of topics, but says nothing about result size, pagination, or how search results are ranked/truncated.

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 motivating warning; every clause is informative. The topic enumeration is long but functionally useful for routing, though the line-wrapped list is slightly dense.

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 reference tool with no output schema, the description covers scope, default behavior, and when to invoke it, which is enough to call it correctly. Minor gaps remain around return shape (it mentions links to dev.max.ru but not structure) and search-vs-topic result differences.

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 documenting the zero-argument mode ('With no arguments returns the list of topics'), which clarifies how the three optional parameters interact and what an empty call produces. It still does not elaborate on how 'query' search behaves versus selecting a whole 'topic'.

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 enumerates the exact subject areas covered (auth, TLS, webhooks vs long polling, keyboards, uploads, mini-apps, initData, deep links, libraries, ads). The topic list lets an agent separate this from narrower siblings such as max_limits, max_endpoint_info, or max_deeplink without opening the schema.

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 timing: 'use this before writing MAX code,' motivated by the warning that models usually know an outdated API (platform-api.max.ru, token in query, GET /chats). It does not name sibling tools or say when to prefer a specialized tool over this reference, so it falls short of full when/when-not/alternatives guidance.

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