Skip to main content
Glama
Sign In
bit-1c-help

bit-1c-help

by firstBitMarksistskaya
OverviewSchemaSourceRelated ServersDiscussionsAdmin
JavaScript
Hybrid

get_1c_platform_help_section

Retrieve the exact help section by its stable id from 1C:Enterprise documentation search results. Use to access a specific fragment directly without surrounding context.

Instructions

Прочитать точный фрагмент по стабильному id из выдачи search. Предпочтительнее get_1c_platform_help_document, когда нужен ровно найденный раздел без лишнего контекста.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

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

Input Schema

NameRequiredDescriptionDefault
idYesStable section id returned by search_1c_platform_help.
rootNoOptional absolute path to a help directory. Defaults to BIT_1C_HELP_ROOT or ./kb.
sourceNoOptional source subdirectory used for the original search.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.5.1

TDQS

A3.5/5.0
Behavior2/5

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

No annotations are provided, so the description carries the full burden. The verb 'read' implies a read-only operation, but the description does not disclose return format, error behavior, whether the id must come from a prior search, or what happens if the id is invalid. With no annotations and no output schema, this is a significant gap for a non-trivial tool.

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?

The description is two sentences, front-loaded with the core purpose, and the second sentence conveys a helpful routing rule. It earns its place, though the distinction between 'fragment' and 'section' in the second sentence is slightly confusing and could be phrased more crisply.

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

Completeness2/5

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

With no output schema and no annotations, the description should explain what the tool returns, when the id is unavailable, and how root/source affect the lookup. It only covers basic purpose and one sibling alternative. For an operation that depends on an external search result, the context provided is incomplete.

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?

The schema has 100% description coverage for all three parameters, so the description does not need to add much. It only restates that the id comes from the search output, which is already in the schema. No additional meaning beyond the input schema is provided, warranting the baseline 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?

The first sentence clearly states a specific verb and resource: 'read the exact fragment by stable id' from the search output. It also names get_1c_platform_help_document and gives a differentiating condition, so an agent can distinguish this tool from its sibling 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?

It explicitly says get_1c_platform_help_document is preferable when you need exactly the found section without extra context, giving a conditional routing instruction. However, it does not explicitly cover when not to use this tool or mention the other siblings like search_1c_platform_help, so it is not a full replacement for usage guidance.

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

Deploy Server

Other Tools