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. | No |
get_webhook_configuration | A webhook's configuration. | No |
list_external_webhooks and get_external_webhook | Webhooks that deliver changes to iPaaS.com. | 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. | 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. | 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. You can filter by status, name or IDs. | No |
get_transfer_error | One recorded run, with its detail entries. | 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. | 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. | 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. | 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. | Yes (sends data) |
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. | 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 | 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.
The platform keeps recent jobs only, for about 48 hours, so an old resync can't be checked.
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.