scrapewise_update_matcher_engine_setup_fields
Changes some fields of the engine setup of a group on the newer matching engine with a JSON merge patch
(RFC 7396), without sending the whole setup: an object merges key by key, so a map keyed by scraper id
(columnsByScraper, derivedKeysByScraper, codeKeysByScraper, ...) takes one source at a time; null
removes a key (back to its default); a list (joins, ignoreScraperIds, ...) or a value replaces the field
whole. All the changes of one call become ONE new version and are checked together, so related edits
(rename a role column and re-key every source that uses it) go live together or not at all. The group's
owner (Full key or portal) changes the fields whose writer is customer (GET include=fields); picture
fields and engineEnabled are Scrapewise's (null on one of them is refused too). A Scrapewise admin key
changes everything. The matcher checks the draft within about a minute.
Args:
- id (string, path, required): the group's id.
- idempotency_key (string, query): REQUIRED for AI-agent keys. A new value per new change; the same
value only to retry it. After a 4xx nothing was saved: you may retry with the SAME key.
- body (required): editVersion (from the last read; required with patch), patch (the merge patch),
requireIdle (default true). Do not send engineEnabled (admin/support only): from the owner a value
other than the current state is 403 ENGINE_SWITCH_ADMIN_ONLY; the current state is a no-op.
- customerRef (string, query, optional): only for a Scrapewise admin key in Take Over.
Returns:
The small setup answer: status PENDING, editVersion, saveWarnings (LIST_WIDENED_TO_ALL:<field> when a
list that means "every source" when absent was removed). VALIDATOR_DOWN = your draft is saved and waits
for the check; the active setup is unchanged; do not resend. A later read with REJECTED = the check
refused the draft: the active setup is unchanged; your next save starts from the active setup, so send
your whole change again (an UNKNOWN_KEY refusal may still go live after a matcher update until you save
again).
Examples:
- Use when: "source S has no raw EAN column" -> patch {"columnsByScraper": {"S": {"ean": "eanRawNone"}}}.
- Use when: "ignore scraper X too" -> patch {"ignoreScraperIds": [ ...the whole new list... ]}.
- Don't use when: you replace the whole setup or restore a version -> scrapewise_update_matcher_engine_setup.
Error Handling:
- 400 IDEMPOTENCY_KEY_REQUIRED, ENGINE_SETUP_INVALID, UNKNOWN_SCRAPER_ID, JOB_NOT_OF_SOURCE,
NOT_ON_NEWER_ENGINE, ENGINE_SETUP_TOO_DEEP, PHOTO_LINE_VALUE_MISSING (photoMode confirm / open while a
picture line has no threshold). Nothing was changed.
- 409 VERSION_CHANGED (read again, redo the edit), SETUP_FROM_DB_OFF, NOT_SEEDED, OWN_MATCH_RUNNING /
SCRAPER_RUN_IN_PROGRESS (wait, retry with the SAME key), ENGINE_DISABLE_NEEDS_EMPTY_MATCH,
ENGINE_ENABLE_WAITS_FOR_RETRIGGER, TAKE_OVER_ACTIVE, IDEMPOTENCY_IN_FLIGHT, ARGS_HASH_MISMATCH,
PHOTO_SWITCH_STILL_ON (the owner takes photoMode off confirm / veto / score while photo checks are on: switch
them off in the match setup first).
- 403 FIELD_ADMIN_ONLY / FIELD_NOT_CUSTOMER_WRITABLE (a field the owner may not change),
ENGINE_SWITCH_ADMIN_ONLY (engineEnabled from the owner), NOT_ON_NEWER_ENGINE (the owner's setup for a group not on it); 403 for a read-only key.
- 413 ENGINE_SETUP_TOO_LARGE; 503 FIELD_LIST_UNKNOWN.
- 429 OWNER_EDIT_RATE_LIMIT: more than 10 owner changes of this group in 10 minutes; wait Retry-After.
- IDEMPOTENCY_IN_FLIGHT (an idempotency conflict): retry after a second.
- 5xx: read again (scrapewise_get_matcher_engine_setup) before retrying.
- 401 Unauthorized; 404 unknown group or another customer's group. Nothing was changed in each refusal.[runtime hint] This tool returns JSON-as-text — its response shape is dynamic (per-scraper itemsConfig, file binary, etc.) so the MCP outputSchema is omitted. Do not rely on the presence of any specific field in the response; treat the result as a string-or-object blob and parse defensively.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"id": "<id>",
"idempotency_key": "<idempotency_key>",
"body": "<body>"
},
"name": "scrapewise_update_matcher_engine_setup_fields"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | the group's id. | |
| body | Yes | Change some fields of the engine setup of a group (JSON merge patch, RFC 7396). | |
| customerRef | No | Admin keys in Take Over only: the customerUniqueRef of the customer the admin works for. Required then; leave it out otherwise. | |
| idempotency_key | Yes | Required for AI-agent keys: a new value per new change, the same value only to retry it. |