@scribed/cli 0.1.11 → 0.1.13

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -178,6 +178,21 @@ scribed call lead_runs_list limit=20
178
178
  scribed mcp --categories core,personal-chat,personal-notes,documents,scribed-quest
179
179
  ```
180
180
 
181
+ ## Enrichment
182
+
183
+ Enrich existing contacts or companies through the shared `enrich_*` tools. Enable the opt-in MCP category with `scribed mcp --categories core,enrichment` (hosted MCP: `?categories=core,enrichment`). CLI calls are available without a category switch:
184
+
185
+ ```bash
186
+ scribed tools list --category enrichment
187
+ scribed call enrich_status
188
+ scribed call enrich_estimate --input enrichment-selection.json
189
+ scribed tools show enrich_start
190
+ ```
191
+
192
+ The selection file contains `collectionId` and exactly one of `recordIds` or `target` (an ID list or saved-view query), plus the intended options. After a successful estimate, review its counts and credit range, reveal options, and whether to fill empty fields or overwrite existing values. To start, use the same selection/options, copy the approved estimate into `expectedEstimate`, set `options.maxCredits` to the approved estimated maximum and set `confirmed: true`. Submit that reviewed file with `scribed call enrich_start --input enrichment-approved.json`.
193
+
194
+ Start re-estimates before submitting and refuses a changed, unavailable or empty estimate. The API also rechecks the final selection against the approved credit budget before admission. Credits are Apollo units, not dollars; completed usage follows the existing billing policy (default 10× actual Apollo cost). The worker checks its credit budget between chunks, so it is not an absolute provider-spend ceiling. After an uncertain start, inspect `enrich_jobs_list` and `enrich_job_get` rather than resubmitting. `enrich_job_records` reads the write-back ledger; `enrich_cancel` and `enrich_apply` require explicit confirmation. Applying defaults to filling empty fields and spends no new Apollo credits. These three mutations are unavailable to background Runs.
195
+
181
196
  ## Commands
182
197
 
183
198
  Global flags on every command: `--json`, `--api-url <url>`, `--upload-api-url <url>`, `--workspace <id>`.