Skip to main content
Glama
mdemyanov

gramax-docportal-mcp

by mdemyanov

gramax_list_catalogs

List all documentation catalogs available on the Gramax portal. Returns a table with catalog names and IDs to help identify and navigate to the relevant documentation.

Instructions

Получить список всех каталогов документации на портале Gramax.

Возвращает таблицу с названиями и ID каталогов.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.3.2

TDQS

A3.9/5.0
Behavior3/5

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

No annotations are provided, so the description carries the behavioral disclosure burden. It states that the tool returns a table with catalog names and IDs, which is useful, but it does not mention pagination, authentication, rate limits, or side-effect characteristics. For a zero-parameter read-only listing, this is adequate but not rich.

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?

The description is two concise sentences with the action and result front-loaded. It contains no filler, no repetition of schema details, and every sentence adds value.

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?

For a simple zero-parameter listing tool with an output schema, the description is complete: it specifies the scope (all documentation catalogs) and the return content (names and IDs). Nothing essential is missing for correct invocation.

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?

The tool has zero parameters and the schema is fully covered at 100%, so there is no parameter semantics gap. With zero parameters, the baseline is 4, and the description does not need to add anything.

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?

The description uses a specific verb and resource: 'Получить список всех каталогов документации на портале Gramax' (get a list of all documentation catalogs on the Gramax portal). It is clearly distinct from sibling tools like search, navigation, and article retrieval.

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

Usage Guidelines2/5

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

There is no explicit guidance about when to use this tool versus the sibling tools. It does not mention conditions, alternatives, or prerequisites, leaving the agent to infer that this is simply the tool for listing catalogs.

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