Skip to main content
Glama

get_1c_platform_help_document

Fetch full 1C:Enterprise help document content by path from search results. Use offset and maxChars to paginate or read around search matches.

Instructions

Прочитать документ целиком, постранично (offset + maxChars, продолжать по nextOffset). Брать, когда нужен контекст вокруг найденного или файл целиком. path — из выдачи search_1c_platform_help.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pathYesRelative path returned by search_1c_platform_help.
rootNoOptional absolute path to a help directory. Defaults to BIT_1C_HELP_ROOT or ./kb.
offsetNoZero-based character offset from which to read the document. Use nextOffset from the previous response to continue.
sourceNoOptional source subdirectory returned by list_1c_platform_help_sources. When set, path is resolved inside that source.
maxCharsNoMaximum number of characters to return.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.5.1

TDQS

A4.2/5.0
Behavior4/5

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

Аннотаций нет, поэтому описание само раскрывает поведение: операция является чтением, а не изменением, и требует постраничного прохода через offset/maxChars с продолжением по nextOffset. Это значимая поведенческая деталь. Не описаны возможные ошибки или формат ответа, но для read-only инструмента с полной схемой этого достаточно.

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?

Три коротких предложения без лишней информации: действие, условие использования и источник path. Ключевая суть вынесена вперёд, каждое предложение несёт полезную нагрузку.

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?

С учётом пяти параметров, отсутствия output-схемы и отсутствия аннотаций описание покрывает главное: что делает, когда применять, откуда брать path и как листать документ. Небольшой пробел — не описан формат ответа и нет явного противопоставления get_1c_platform_help_section, но в целом инструмент можно вызвать корректно.

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

Parameters3/5

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

Входная схема покрывает 100% параметров и уже объясняет path как относительный путь из search_1c_platform_help, offset для продолжения по nextOffset и source для разрешения внутри источника. Описание лишь повторяет связь path с поиском и не добавляет новой семантики сверх схемы, поэтому по калибровке уместен базовый 3.

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?

Описание начинается с конкретного действия: «Прочитать документ целиком, постранично», и уточняет ресурс (документ справки) и способ чтения через offset + maxChars и nextOffset. Это ясно отделяет инструмент от get_1c_platform_help_section, которая по названию возвращает раздел, а не весь документ. Также указано происхождение path — из выдачи search_1c_platform_help.

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?

Прямо указано условие применения: «когда нужен контекст вокруг найденного или файл целиком». Это даёт агенту понятный сигнал для выбора после поиска. Однако явные альтернативы и случаи, когда использовать get_1c_platform_help_section, не названы, поэтому не 5.

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