Skip to main content
Glama
mdemyanov

gramax-docportal-mcp

by mdemyanov

gramax_ai_search

Answers free-form questions about Gramax documentation by generating a coherent response with source links, instead of returning a list of matching articles.

Instructions

AI-поиск по документации Gramax: связный ответ с ссылками на источники.

Использовать для вопросов в свободной форме, когда нужен сгенерированный ответ, а не список релевантных статей. Для списка результатов — gramax_search.

Args: query: Вопрос на естественном языке. catalog_name: Имя каталога для контекста (без него — по всем). articles_language: Язык статей в индексе ("ru", "en", ...). По умолчанию не задаётся: на некоторых порталах непустое значение обнуляет выдачу. Задать явно или через GRAMAX_AI_ARTICLES_LANGUAGE, если портал этого требует. response_language: Язык генерируемого ответа. По умолчанию — из GRAMAX_AI_RESPONSE_LANGUAGE (ru). current_article: ID текущей статьи как контекст ("catalog_id/path").

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
queryYes
catalog_nameNo
current_articleNo
articles_languageNo
response_languageNo

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.3.2

TDQS

A4.8/5.0
Behavior4/5

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

With no annotations, the description carries the full burden, and it does disclose meaningful behavior: the output is a generated answer with source links, plus the important quirk that a non-empty articles_language can zero out results on some portals and that defaults come from environment variables. It does not discuss permissions or rate limits, but for a read-only search tool these are minor omissions.

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

Conciseness5/5

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

Front-loads purpose and routing guidance, then documents arguments compactly. Every sentence earns its place, and given the 0% schema coverage the argument listing is necessary rather than filler.

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

Completeness5/5

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

With an output schema present, return format needn't be detailed, yet the description still gives the essential output nature (generated answer with sources). All five parameters are documented, alternatives are named, and no annotation-derived gaps remain.

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

Parameters5/5

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

Schema description coverage is 0%, so the description must fully document the five parameters, which it does. Each argument is explained with meaning and defaults, including the critical articles_language behavior, the env-var fallbacks, and the 'catalog_id/path' format for current_article.

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 ('AI-поиск по документации Gramax') and explicitly says the output is a 'связный ответ с ссылками на источники'. It also directly distinguishes itself from the sibling gramax_search by contrasting generated answers with a list of articles.

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

Usage Guidelines5/5

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

Explicitly says when to use it ('для вопросов в свободной форме, когда нужен сгенерированный ответ') and names the alternative with its condition ('Для списка результатов — gramax_search'). This leaves no ambiguity about tool selection.

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