Skip to main content
Glama

kb2_document_create

Create Bitrix24 Knowledge Base documents using a two-step flow: first request a preview with confirm=false, then create the document with confirm=true only after the user confirms.

Instructions

WRITE: создать документ Базы знаний 2.0 через note.document.add. Сначала вызови с confirm=false и покажи preview пользователю. Передавать confirm=true разрешено ТОЛЬКО после явного подтверждения пользователем именно этого создания в текущем диалоге. Bitrix24 создаст документ только если у пользователя webhook есть право создания в указанной базе/родителе.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
titleYesЗаголовок нового документа, максимум 255 символов
confirmYestrue только после явного подтверждения пользователем показанного preview в текущем диалоге; без такого подтверждения всегда false
markdownNoПолное содержимое нового документа в Markdown, максимум 1 МиБ. По умолчанию пустая строка.
parent_idNoID родительского документа/раздела; например 77 для 'Планы на спринт'. Если не указан, документ создаётся в корне базы.
collection_idYesID базы знаний из kb2_list/kb2_tree
expected_preview_keyNoТочный preview_key из confirm=false; обязателен при confirm=true
allow_duplicate_titleNoРазрешить создание документа с тем же title в том же parent_id. По умолчанию false.
Behavior4/5

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

With no annotations provided, the description carries the full transparency burden. It discloses the write nature, the two-phase confirmation requirement to prevent accidental creation, and the webhook permission dependency. This is substantive behavioral context beyond a simple 'creates a document', though it does not describe the exact response or error behavior.

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 only two sentences long, with the critical 'WRITE' keyword front-loaded. Every clause earns its place: what it does, the confirm=false→preview→confirm=true flow, and the permission caveat. There is no verbose or redundant content.

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?

Given 7 parameters and no output schema, the description adequately covers the essential operational context: the confirmation protocol and permission requirements. It does not detail the shape or contents of the preview response or error conditions, but the rich schema compensates for parameter-level gaps. This is a solid, usable description.

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 input schema already covers 100% of parameters with detailed descriptions, so the baseline is 3. The description adds extra meaning to the confirm and expected_preview_key parameters by explaining their workflow relationship (first call returns preview, second call requires matching preview_key). This exceeds baseline.

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 opens with 'WRITE' and explicitly states the action: 'создать документ Базы знаний 2.0' (create a Knowledge Base 2.0 document) via note.document.add. This clearly identifies a create operation on a specific resource and naturally distinguishes it from sibling tools like kb2_document_update or kb2_document_delete.

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?

The description gives explicit usage workflow: call with confirm=false first and show the preview to the user, then pass confirm=true only after explicit user confirmation. It also states the permission prerequisite. However, it does not explicitly contrast with alternative tools (e.g., when to use update instead of create), so it stops short of a 5.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/imejaikin/bitrix24-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server