Fetch Bitrix24 event documentation by exact event name (use bitrix-search with doc_type event). Returns Markdown with title, metadata (URL/module/category), description, and content.
| Name | Required | Description | Default |
|---|---|---|---|
| title_or_hint | Yes |
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are provided, so the description carries the full burden. It describes the return format (Markdown with title, metadata, description, content) but does not disclose edge cases like behavior when event is not found, case sensitivity, or read-only nature. Lacks error handling details.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two sentences with no filler. The description is front-loaded with the action and resource, includes a usage hint, and specifies the return format. Every element earns its place.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a simple one-parameter read tool with an output schema, the description covers purpose, parameter semantics, usage, and return format. It omits potential error behavior and prerequisites, but these are not critical for basic invocation. Overall sufficient for an agent to use correctly.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema has one parameter 'title_or_hint' with 0% coverage. The description implies it should be the exact event name, providing some meaning beyond the schema. However, the parameter name is ambiguous ('title_or_hint') and not explicitly mapped to the event name, leaving room for confusion.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
Clearly states the tool fetches Bitrix24 event documentation by exact event name, using a specific verb ('Fetch') and resource. It distinguishes itself from sibling detail tools by focusing on events and referencing bitrix-search.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Provides implied usage guidance by instructing to use `bitrix-search` with doc_type event, which suggests a search-then-details workflow. It does not explicitly list exclusions (e.g., for methods or articles), but the event-specific scope is evident.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Add one secure layer between your agents and this server.
Each tool has a clearly distinct purpose: bitrix-search is for general searching, while the other four tools each fetch details for a specific documentation type (app development, articles, events, methods). The descriptions explicitly differentiate them by doc_type and output format, leaving no ambiguity about which tool to use for a given task.
All tool names follow a consistent pattern: 'bitrix-' prefix, followed by a descriptive noun or noun phrase (e.g., 'search', 'method-details'), and ending with '-details' for the four detail-fetching tools. This verb_noun-like structure is uniform throughout the set, making it predictable and easy to understand.
With 5 tools, the set is well-scoped for a documentation server focused on Bitrix24. It includes a search tool and four detail tools covering key documentation types, which is efficient and avoids bloat. Each tool serves a clear, necessary function without redundancy.
The tool surface is complete for the domain of fetching Bitrix24 documentation. It covers the full workflow: searching across all doc types with bitrix-search, then retrieving detailed information for each specific type (app development, articles, events, methods). There are no obvious gaps, as agents can seamlessly move from search to details without dead ends.