Skip to main content

iPaaS.com MCP: Tool Reference - Operations

The Operations tools in the iPaaS.com MCP server: webhooks, events and polling, errors, logs, diagnosing failures and resyncing records (beta).

Before you start to use our MCP, please review the following items:

  • Ensure you have completed the iPaaS.com platform training before using this to best understand what is going on. If you need to gain access to it reach out to partnerships@ipaas.com.

  • With great power comes great responsibility - the MCP can do things like trigger a sync for your entire catalog and modify (or remove) data from your account. Ensure you understand what you want it to do before you work with it. iPaaS.com is not responsible for restoring any data or configuration changes made using the MCP.

  • Measure twice, cut once: When working with this, planning ahead of time (or asking the MCP to plan for you) will greatly benefit your work.

  • Remember that this is in beta so some features may be added, removed or altered as we continue our development. The latest change log notes can be found here.

  • If you have any issues or need to report a bug please reach out to us at mcp@ipaas.com.

These are the tools for keeping syncs healthy: webhooks, events and polling, the error queue, logs, diagnosing failures and resyncing records. Connect with https://mcp.ipaas.com/mcp/operations to get just these (see Choosing Your Tools). For how to use them step by step, see Investigating a Failed Sync. You don't normally type tool names. Ask in plain language and the assistant picks the tool.

Take extra care with this set. It includes tools that send data to other systems, delete webhooks and change poll schedules. Read Safety, Permissions and Limits before you confirm any of them.

The tools

Webhooks

A webhook sends a scope's changes to a destination system, or delivers changes from a system into iPaaS.com.

Tool

What it does

Changes data?

list_webhooks and get_webhook

Webhooks that send changes from iPaaS.com. Credentials come back masked.

No

get_webhook_configuration

A webhook's configuration. Credentials come back masked.

No

list_external_webhooks and get_external_webhook

Webhooks that deliver changes to iPaaS.com. Credentials come back masked.

No

enable_webhook

Starts sending a scope's changes to a destination. Enabling creates the webhook. It refuses to create a second one for the same scope and destination, since a duplicate makes a record fire twice. If what you type matches more than one scope, it asks which one you mean. For a webhook a connected system uses to send changes into iPaaS.com, the scope must be one that system's integration defines. Otherwise it refuses and lists the scopes it does. The result says what the new webhook does.

Yes (preview first)

disable_webhook

Stops sending a scope's changes to a destination. Disabling deletes the webhook permanently. It can't be reactivated, and enabling again creates a new one with a new ID.

Yes (preview first, permanent)

Events and polling

A system that can't push changes gets them into iPaaS.com by being polled on a schedule.

Tool

What it does

Changes data?

list_events and get_event

The scheduler's events, decoded: type, system, scope, schedule and last run.

No

list_poll_scopes

What a system can be polled for.

No

check_event_run

Did an event run? Reads its last run and compares it against a time you give, then points to the errors and transfer runs for the event's connected system since that run. The run's own ID doesn't match an error, so it isn't used to look them up.

No

create_event

Creates a poll event or a scheduled event. It checks the system, the scope and the schedule first.

Yes (preview first)

update_event

Changes an event's schedule, scope, system or name.

Yes (preview first)

delete_event and reactivate_event

Stop or restore an event. Deleting a poll event stops that system's pull.

Yes (preview first)

run_poll_event_now

Forces a poll to run soon. It does this by rewriting the schedule to run once, about two minutes from now, and gives you the call that restores the original schedule.

Yes (preview first)

Errors and logs

Tool

What it does

Changes data?

list_errors and get_error

The sync error queue. You can filter by the ID of the job that produced an error (its reference ID), external ID, connected system or status.

No

dismiss_errors

Clears errors from the queue once their cause is dealt with, or moves them to another status. It works on up to 25 at a time. Dismissing doesn't fix or retry anything.

Yes (preview first)

list_logs and get_log

Platform logs.

No

list_transfer_errors

The transfer run log, newest first. You can filter by status, name or IDs. Empty run records, which make up most of the raw log, are left out unless you ask for them. The log isn't stored in time order, so when it is too big to read at once, the tool reads the newest runs by time window and says from when. To reach older runs, narrow by connected system, record ID or name.

No

get_transfer_error

One recorded run, with its detail entries: every call the connector made, in order, with the platform's own messages. For a resync, look it up by the job ID (the hook ID the resync returned). A job started by a webhook or a poll usually has no recorded run.

No

Diagnosing and fixing

Tool

What it does

Changes data?

diagnose_error

Reads an error by its own ID or the ID of the job that produced it, classifies it, points to the help article to read, and hands back what is needed to resync the record. It recognises a record that wasn't found and an error inside the integration's own code, and flags an external ID that looks like a placeholder, such as 0, N/A or null. It also says at which stage the run failed (when nothing was sent, it failed while building the request), lists other errors with the same message, and starts with read-only checks, such as lookup coverage, before it suggests a configuration change.

No

check_lookup_coverage

Checks whether each translation table in a flow out of iPaaS.com has a row for the values your failing records carry. It reads up to 10 failing Product, Customer, Transaction or Gift Card records and lists first the values that no row covers. A value with no row sends nothing for that field, which can fail a transfer before anything is sent.

No

plan_error_fix_loop

Groups errors by root cause, says which you can fix in iPaaS.com and which need a change elsewhere, and lays out the fix sequence with its approval steps. It plans only.

No

run_live_diagnostic

A heavy last resort that re-runs a transfer against a real record and returns its checkpoints. It asks you to confirm first. When the run returns nothing, it looks for the reason in the platform log and in the connected system's most recent load or connection failure, and says whether anything has synced since.

No (uses a real record)

Resyncing records

Tool

What it does

Changes data?

resync_record

Sends one record between iPaaS.com and a connected system. The preview checks that the integration supports the data type and direction. After sending, it reports whether the record was delivered, not delivered with the reason, or still running. It also names the run's step-by-step record (get_transfer_error with the job ID), and starts with it when the record wasn't delivered. When a record that travels with a parent wasn't delivered, it offers to resync the parent instead. When a record was delivered on a flow with no webhook, it says that records won't move on their own.

Yes (sends data)

resync_batch

Does the same for a list of records, up to 25 at a time. It lists every record in the preview, and is blocked outright if the data type or direction isn't supported. After sending, it reports the same for each record. In one session, more than 1,000 records of one data type to one system in one direction, counting resync_record too, needs an approved plan from plan_bulk_resync. Like resync_record, it offers to resync the parent of records that weren't delivered, and it hands back a check_batch_completion call for the batch.

Yes (sends data)

plan_bulk_resync

Plans a large resync, such as "sync all our customers". It counts what would move, then stops. Nothing is sent until you confirm the exact scope, say whether the mappings have been tested on a small set, and accept that the run proceeds at your own risk. Once you approve, it hands out batches of 25 for resync_batch.

No (sends nothing itself)

check_hook_completion

Checks the outcome of a resync job, including whether the record was delivered. A run that says Complete may still have sent nothing, and this tells you when that happened and why. It reads the direction from the job, so you don't need to give one. A job that is still in progress 10 minutes after it started, and no longer waiting in the queue, is reported as Stalled, with the reason when the platform log has one. It names the job's step-by-step record, and for a resync that failed or wasn't delivered it starts there. If the job failed before its connector ran, it starts with the job's own reason instead. Given a poll's run ID instead of a job ID, it says so and lists the jobs that poll produced. For an older poll run, give it the event, or use a run ID the assistant reported earlier in the conversation, and it says the run has finished.

No

check_batch_completion

Checks a whole batch of resync jobs at once, up to 100. It says how many records landed, were filtered out, errored, are still pending or weren't found, and whether the batch is done.

No

check_records_landed

After a sync into iPaaS.com, shows which external IDs now resolve to an iPaaS.com record.

No

lookup_ipaas_id_special

Finds the iPaaS.com ID for an external ID that contains characters such as /, ? or # that break the normal lookup.

No

find_records_by_subscription

Scans a data type for records that carry an external ID from a given system.

No

Good to know

  • Firing a sync isn't the same as the record arriving. Syncs run in the background, and a run can finish having sent nothing if a mapping filter excluded the record.

  • Manual resyncs ignore whether a webhook is enabled.

  • Job history is reliable for about 48 hours. An older job may occasionally still show, but don't count on it. For an older run, look at the error queue and the transfer run log instead.

  • Changes are previewed first. A tool that changes data shows exactly what it would send and changes nothing until you confirm.

Permissions

Give your key View on Webhook, Error, Integration Monitoring Error Logs, Integration Monitoring Activity Logs, Event, Event Rules, Subscription and External Id to read. To resync, add Manual Sync, plus the permission for the type of record you are sending. Show Unmatched and Debug Tracing cover the unmatched-record and diagnostic tools. Add Create, Edit or Delete only for the changes you want to make. See Getting Started. Ask the assistant to check your permissions if a tool returns a 401.

Questions or bugs: mcp@ipaas.com.

Did this answer your question?