CHANGELOG.md

CHANGELOG.md

1. # Changelog
3. Newest first. Tool contracts (names, parameters and docstrings) are listed
4. where they changed; everything else is internal.
6. ## Unreleased
8. Internal cleanup; no tool, parameter, docstring, reply or configuration
9. changes (the 30-tool contract is now pinned by `tests/tool_api.json`).
10. - The version history moved out of the `server.py` docstring into this file.
11. - Shared helpers replace repeated code: record-id validation, the write
12. guards (a decorator on each write tool), local timestamp display, stage
13. lookup and name joining; one user cache instead of two; the contact and
14. company create/update tools share one implementation.
15. - Imports that sat inside functions are at the top of the module.
16. - Added `pyproject.toml` (ruff and pytest settings), unit tests with a faked
17. Bitrix client and `httpx.MockTransport`, and a CI workflow.
19. ## 1.15.1 (2026-07-20)
21. A Bitrix pipeline rename no longer revokes deal writes. `BITRIX_WRITE_FUNNELS`
22. now defaults to categoryIds (`24,26,36`) instead of names: categoryIds are
23. stable across renames, and entries may still be names. `_allowed_funnel_cats()`
24. resolves each entry independently: an entry that cannot resolve is skipped
25. with a warning instead of disabling all deal writes, and it only errors if
26. none resolve. (Funnel 24, then "Partner Outreach", had been renamed to
27. "Partner Tier Upgrade", which broke every deal write.)
29. ## 1.15.0 (2026-07-20)
31. Packaging: the `.mcpb` now uses the MCPB uv runtime (`server.type` "uv",
32. manifest 0.4) instead of bundling per-platform native wheels for one pinned
33. Python. Dependencies live in `mcpb/pyproject.toml` and are resolved on the
34. user's machine by uv, which also provisions a compatible Python. The bundle is
35. Python-version-agnostic (>=3.10, no cp312 ABI lock) and no longer depends on
36. the user's system `python` being present or on PATH, which fixes the Windows
37. "Server disconnected" failure (Store stub, wrong-version python, ABI mismatch).
38. One universal bundle for macOS, Windows and Linux; `build.sh` no longer fetches
39. wheels. Server logic is unchanged.
41. ## 1.14.2 (2026-07-09)
43. The write-funnel default now includes "Partner Outreach" (categoryId 24)
44. alongside Quarterly Check-In Flow and Winback, so deal writes are permitted in
45. that funnel out of the box, matching the deployed `BITRIX_WRITE_FUNNELS` and
46. the `.mcpb` manifest. No effect where the variable is set explicitly.
48. ## 1.14.1 (2026-06-30)
50. Packaging. `BITRIX_DATA_DIR` lets logs and schema snapshots be written to a
51. stable, writable location (default next to the server; the `.mcpb` points it
52. at `~/.bitrix24-mcp`) so a packaged install survives updates. Ships as a
53. single universal desktop extension carrying both the macOS and Windows native
54. binaries: the org connector stores one versioned bundle per connector, so one
55. `.mcpb` must serve every platform.
57. ## 1.14.0 (2026-06-30)
59. Deploy hardening and expansion, verified against the live REST docs via the
60. b24-dev-mcp documentation server.
61. - Security: tool-call logging redacts customer names as well as email and
62. phone by default (`BITRIX_LOG_ARGS=redact|full|off`), and `calls.jsonl` is
63. size-capped and rotated. Untrusted CRM free text (record fields, timeline
64. bodies, website-chat messages) is wrapped in explicit "untrusted data"
65. fences before it reaches the model. Record IDs are validated as numeric at
66. tool entry.
67. - Efficiency: one shared `httpx.AsyncClient` (connection pooling) instead of
68. one per call. New `bitrix_batch()` wraps `rest.batch` (up to 50 commands)
69. and powers `pipeline_summary` (N stage counts in one call), `search_crm` and
70. bulk user-name resolution. Duplicate field formatters merged.
71. - New reads: `get_chat_transcript` (`imopenlines.crm.chat.get` then
72. `im.dialog.messages.get`) surfaces website-chat conversations bound to a
73. lead, deal, contact or company, and `get_timeline` gains a Website chats
74. section. `get_call_recording` exposes the telephony recording URL and file;
75. `transcribe_call` (opt-in, local mlx-whisper) sits behind
76. `BITRIX_TRANSCRIBE`. `get_record` and `get_products` gain an Order summary
77. block (order id, invoice, money totals, partner tier).
78. - New writes (gated by `BITRIX_WRITES`): `set_lead_fields` and
79. `set_deal_fields` set custom fields by display label; `create_contact`,
80. `update_contact`, `create_company` and `update_company` are gated
81. additionally by `BITRIX_WRITE_PARTIES` and dup-checked via
82. `crm.duplicate.findbycomm` before create.
83. - Bitrix CoPilot output and transcripts are not REST-readable, and a call's
84. `TRANSCRIPT_ID` has no getter, so CoPilot-style value comes from the model
85. summarizing the data these tools expose, not from reading CoPilot itself.
87. ## 1.13.1 (2026-06-12)
89. `list_records` with a scoped pipeline no longer builds a cross-funnel stage
90. filter (it shows the whole funnel unless a stage is given); item extraction
91. tolerates list- or dict-shaped results.
93. ## 1.13 (2026-06-12)
95. Deal writes, locked to `BITRIX_WRITE_FUNNELS` (default "Quarterly Check-In
96. Flow,Winback,Partner Outreach"). Every write verifies the deal's categoryId is
97. in that set and refuses otherwise; `create_deal` only creates into those
98. funnels. The tools map to the New-Deal form: `set_deal_stage`,
99. `set_deal_title`, `link_deal_contact`, `link_deal_company`,
100. `add_deal_comment`, `assign_deal`, `create_deal`. Contact and company links
101. resolve an existing record by email, phone or name (no new records are
102. created). Gated by `BITRIX_WRITES`.
104. ## 1.12 (2026-06-12)
106. `pipeline_summary` and `list_records` accept a `pipeline` (deal funnel name or
107. categoryId), which scopes deals to that funnel's category and its
108. `DEAL_STAGE_<cat>` stages, so a named customer-success funnel (for example
109. Quarterly Check-In Flow) gets correct per-stage counts and record lists. The
110. funnel is resolved by fuzzy name match via `crm.category.list` (cached).
112. ## 1.11 (2026-06-12)
114. `list_pipelines` (read-only) enumerates deal funnels via `crm.category.list`
115. (each with its stages from `crm.status.list`) and smart processes via
116. `crm.type.list`: the discovery step before scoping `pipeline_summary` or
117. `list_records` to a named non-default pipeline.
119. ## 1.10 (2026-06-05)
121. `get_call_history` (read-only) wraps `voximplant.statistic.get` to surface,
122. per call: localized start time, direction, number, duration, the bound CRM
123. entity (type and id; calls bind to whatever record, often a contact), whether
124. a recording URL is present, and Bitrix's own transcript id and pending flag.
125. Requires the telephony scope on the webhook. This is the probe that decides
126. the call-transcription architecture (Bitrix transcript or local mlx-whisper)
127. and the read foundation the transcription work reuses.
129. ## 1.9 (2026-06-05)
131. First writes. Two lead-only write tools: `add_lead_comment`
132. (`crm.timeline.comment.add`) and `rename_lead` (`crm.item.update` title). Both
133. hardcode the lead entity; neither can touch deals, contacts or companies.
134. Writes are gated by `BITRIX_WRITES` (default on; set "off" to disable).
135. `rename_lead` refuses to overwrite a title that looks human-authored unless
136. `overwrite_named=True`; all write text is sanitized (control characters
137. stripped, length capped). Every write is logged to `calls.jsonl` with before
138. and after. `get_timeline` gains `full_text` to return untruncated activity
139. bodies for the summarize-to-comment workflow. Call transcription is left out
140. on purpose: CoPilot transcripts are not REST-reachable, and raw audio needs the
141. telephony scope plus transcription, a separate project.
143. ## 1.8.3 (2026-06-05)
145. Packaging: `tzdata` added to requirements (Windows has no system timezone
146. database and zoneinfo needs one there), and a missing timezone database no
147. longer stops the server from starting. No tool changes.
149. ## 1.8.2 (2026-06-05)
151. Security hardening: transport-level httpx exceptions are caught, retried and
152. re-raised as `BitrixError` with the webhook URL redacted (previously they
153. could propagate raw); pagination and product-row numeric parsing tolerate
154. malformed API values.
156. ## 1.8.1 (2026-06-05)
158. Stage history field names vary by entity (leads report `STATUS_ID`, deals
159. `STAGE_ID`); both are now read.
161. ## 1.8 (2026-06-05)
163. Reads expansion. `get_products` (`crm.item.productrow.list`) answers "what did
164. they order"; `get_stage_history` (`crm.stagehistory.list`) shows stage
165. movement with time in stage; `get_timeline` includes staff notes
166. (`crm.timeline.comment.list`) with author names; user IDs in `get_record` and
167. `list_records` resolve to names (cached); boolean field filters work via a
168. client-side scan (Bitrix ignores them server-side; the scan is capped at 200
169. records and labeled as such).
171. ## 1.7 (2026-06-05)
173. Timezone-correct dates. `list_records` accepts `created_on`, `created_from`,
174. `created_to` and `tz`; day windows are computed in the local zone
175. (`BITRIX_LOCAL_TZ`, default America/Chicago) and passed to Bitrix as
176. offset-aware ISO 8601 bounds on `createdTime`. Date-filtered queries paginate
177. past the 50-row cap. Timestamps in `get_record` are displayed in local time
178. with the raw offset string preserved; list and timeline lines show local time.
179. zoneinfo throughout, no fixed offsets, DST-safe.
181. ## 1.6.3 (2026-06-05)
183. Security and ship pass: logs live inside the repo folder (they had been
184. written one level up, a leftover of an old `src/` layout); emails and phone
185. numbers are masked in `calls.jsonl` entries; the `search_crm` limit is capped
186. at 50; dependency versions are bounded.
188. ## 1.6.2 (2026-06-04)
190. Boolean `UF_*` filters are refused with an explanation: live testing showed
191. `crm.item.list` silently ignores them and returns the unfiltered set.
192. Enum, string and date filters verified working.
194. ## 1.6.1 (2026-06-04)
196. `crm.item.list` filters on `UF_*` fields require `useOriginalUfNames=Y`, now
197. sent by `list_records`. Bitrix HTTP 4xx error bodies are parsed into
198. `BitrixError` messages instead of surfacing raw httpx exceptions, which
199. embedded the webhook URL, token included, in the error text shown to the
200. client.
202. ## 1.6 (2026-06-04)
204. `find_field` (search field definitions by label or ID fragment across all
205. entity types); `list_records` accepts `field`/`value` to filter on any field
206. by its display label, with enum option labels and yes/no booleans translated
207. automatically; the field schema is snapshotted to `./schema/` (one dated JSON
208. file per entity per day) so form-builder drift is diffable over time.
210. ## 1.5 (2026-06-04)
212. `get_fields`: the full field schema per entity type via `crm.item.fields`
213. (cached). `get_record` labels custom `UF_*` fields with their configured
214. display names and translates enumeration value IDs into their display labels.
216. ## 1.4 (2026-06-04)
218. Assignee support. `pipeline_summary` accepts `assigned_to` ('me', a name, or
219. a numeric user ID, resolved via `user.current`, `user.search` or `user.get`);
220. the new `list_records` tool lists records filtered by assignee and/or stage.
221. User lookups are cached per process.
223. ## 1.3 (2026-06-04)
225. `pipeline_summary`: per-stage counts for leads and deals with human-readable
226. stage names via `crm.status.list` (cached per process). Counts come from the
227. `crm.item.list` response envelope's `total`, so they are exact regardless of
228. page size.
230. ## 1.2 (2026-06-04)
232. Leads (entityTypeId 1) added to all three CRM tools. `search_crm` 'all' covers
233. lead, contact, company and deal; `findbycomm` covers leads. Section headers
234. properly pluralized.
236. ## 1.1 (2026-06-04)
238. CRM reads migrated from the legacy `crm.{entity}.list/get` family (development
239. halted by Bitrix) to the universal `crm.item.*` API. Email and phone lookup
240. uses `crm.duplicate.findbycomm`. Verified against https://apidocs.bitrix24.com
241. (crm-item-list, crm-item-get, crm-duplicate-find-by-comm). Tool contracts
242. unchanged.
244. ## 1.0
246. The core read tools: `search_crm`, `get_record`, `get_timeline` and
247. `list_tasks`, over an incoming webhook (`BITRIX_WEBHOOK_URL`) and stdio. Tool
248. names are semantic rather than Bitrix-specific so the interface survives a
249. future CRM migration: the implementation behind them is what gets swapped, not
250. the contracts. Every call is logged to `logs/calls.jsonl` for migration
251. evaluation.