Skip to main content
Glama

bx24_crm_addresses

Manage Bitrix24 CRM client addresses: create, get, list, update, delete, fetch addresses by client, or remove them by filter.

Instructions

Bitrix24 CRM addresses (адреса клиентов): CRUD, by client, delete by filter. Methods crm.address.*, crm.address.byclient (REST 1.0 + 3.0). RU/EN: адрес, адрес клиента, фактический адрес, юридический адрес / address, client address, actual address, legal address.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idNoEntity ID
orderNoOrder object (e.g. { 'ID': 'DESC' })
startNoPagination offset (number of records to skip)
actionYesOperation to perform: - "add": Create an address - "get": Get an address by ID - "list": List addresses - "update": Update an address - "delete": Delete an address (destructive) - "fields": Describe address fields - "byclient": Get addresses of a client (by entity type + ID) - "deleteByFilter": Delete addresses matching a filter (destructive — bulk)
fieldsNoAddress fields: TYPE_ID (1=actual,6=legal,8=registration), ENTITY_TYPE_ID, ENTITY_ID, ADDRESS_1, CITY, POSTAL_CODE, COUNTRY, REGION, ...
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.
clientIdNoClient (entity) ID for byclient
clientTypeIdNoClient entity type ID for byclient

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.4.0

TDQS

B3.1/5.0
Behavior2/5

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

Since no annotations are provided, the description must carry the full burden of behavioral disclosure. It only states 'CRUD' and 'delete by filter' without describing permanence of deletions, permission requirements, side effects, or consequences of bulk delete. The destructive flags in the action enum are part of the schema, not the description.

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 tight and front-loads the core purpose with a resource label followed by the operation summary. The REST version note and bilingual synonym list are small additions that aid retrieval without introducing significant bloat.

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?

For a tool with 10 parameters, 8 actions, nested objects, and no output schema or annotations, the description is too thin. It omits operational details such as required fields for add, how byclient selects entities, and error or pagination behavior, leaving the schema to carry nearly all invocation-relevant context.

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 adds RU/EN synonym keywords and the REST method family, but it does not clarify parameter relationships, required-field rules for add, or how byclient parameters interact beyond what the parameter descriptions already cover.

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 clearly identifies the resource as Bitrix24 CRM addresses, enumerates the operation families (CRUD, by client, delete by filter), and names the underlying REST methods (crm.address.*, crm.address.byclient). This distinguishes it from sibling tools that target different CRM entities such as deals, leads, or products.

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 provides no explicit guidance on when to use this tool versus alternatives, nor does it mention prerequisites or exclusions. Usage context must be inferred entirely from the tool name and the word 'addresses', with no routing to or away from siblings like bx24_crm_requisites.

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