Skip to main content
Glama

bx24_crm_leads

Manage Bitrix24 CRM leads with full CRUD operations, contact binding, custom fields, product rows, conversion to deals, and card configuration.

Instructions

Bitrix24 CRM leads: CRUD, fields, contacts, user fields. Methods crm.lead.* (REST 1.0 + 3.0). RU/EN: лид, новый лид, создать лид, найди лиды, обнови лид, удали лид / lead, create lead, find leads, update lead, delete lead.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idNoEntity ID
rowsNoProduct row array: {PRODUCT_ID, PRICE, QUANTITY, ...}
orderNoOrder object (e.g. { 'ID': 'DESC' })
startNoPagination offset (number of records to skip)
actionYesOperation to perform: - "add": Create a lead (TITLE required) - "get": Get a lead by ID - "list": List/filter leads - "update": Update lead fields by ID - "delete": Delete a lead (destructive) - "fields": Describe all lead fields — call first when unsure - "contact_get": List contacts bound to a lead - "contact_add": Bind a contact to a lead - "contact_delete": Unbind a contact (destructive) - "contact_items_set": Set the full set of contacts on a lead - "contact_items_delete": Clear all contacts from a lead (destructive) - "userfield_get": Get a custom lead field - "userfield_add": Create a custom lead field - "userfield_update": Update a custom lead field - "userfield_delete": Delete a custom lead field (destructive) - "convert": Convert a lead to a deal/contact - "productrows_get": Get lead product rows - "productrows_set": Overwrite lead product rows (destructive — full rewrite) - "details_get": Get lead card configuration (layout) - "details_set": Set lead card configuration - "details_reset": Reset lead card configuration to default
fieldsNoLead fields: TITLE (required), NAME, LAST_NAME, PHONE[], EMAIL[], COMPANY_TITLE, STATUS_ID, SOURCE_ID, ASSIGNED_BY_ID. Use action=fields for the full list.
filterNoFilter object (e.g. { '>OPPORTUNITY': 10000, 'STAGE_ID': 'WON' })
selectNoArray of field names to return (projection)
confirmNoSet to true to confirm destructive actions when BX24_CONFIRM_DESTRUCTIVE is enabled.
contactIdNoContact ID bound to the lead
userfieldNoUser field definition: FIELD_NAME, USER_TYPE_ID, LABEL, ...
contactIdsNoContact IDs to set
userfieldIdNoCRM userfield ID (e.g. UF_CRM_123)
configFieldsNoLead card configuration (details.configuration.*) fields

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.4.0

TDQS

C2.9/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 behavioral-transparency burden. It only states API method families and REST versions, without disclosing auth needs, rate limits, irreversibility, or confirmation behavior. The schema's action enum marks some actions as 'destructive', but the description itself adds no such context.

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 compact and front-loaded with the resource and scope. The RU/EN synonym list adds length but serves multilingual query matching. No redundant filler, though the synonym list is slightly more than strictly necessary.

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

Completeness3/5

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

The description provides a broad overview but omits several action families present in the schema, such as productrows_*, details_*, and convert. With 14 parameters and 21 actions, the top-level description is thin. However, the schema itself is extensively detailed with 100% coverage, so the combination is mostly adequate for an agent.

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?

Schema description coverage is 100%, so the baseline is 3. The description itself adds no parameter-level meaning; it merely lists categories. The detailed action and parameter descriptions reside in the schema, which already documents all parameters thoroughly.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly identifies the resource ('Bitrix24 CRM leads') and the main capability areas ('CRUD, fields, contacts, user fields'). This distinguishes it from sibling CRM tools at a glance, though it is an umbrella for many actions rather than a single specific operation.

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?

The description gives no explicit when-to-use guidance or alternative tool exclusions. It does not reference sibling tools such as bx24_crm_deals or bx24_crm_contacts. The only usage hint ('call first when unsure') lives inside the schema's action enum for 'fields', not in the description.

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