Skip to main content

iPaaS.com MCP: Tool Reference - Product and Catalog

The Product and Catalog tools in the iPaaS.com MCP server: products, variants, inventory, categories, locations, kits, prices and external IDs (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 the product catalog: products, variants, inventory, categories, locations, kits and prices. Connect with https://mcp.ipaas.com/mcp/product to get just these (see Choosing Your Tools). You don't normally type tool names. Ask in plain language and the assistant picks the tool.

The tools

Look things up

Tool

What it does

Changes data?

list_products

Searches products by name, SKU, type or alternate ID.

No

get_product

One product, with its variants, inventory, categories, options and units.

No

list_product_variants

Lists variants, the sellable SKUs.

No

get_product_variant

One variant.

No

list_categories and get_category

Product categories.

No

list_category_sets and get_category_set

Groupings of categories.

No

list_locations and get_location

Inventory locations.

No

list_location_groups and get_location_group

Groupings of locations.

No

get_product_inventory

Stock for an item whose inventory is tracked on the product.

No

get_variant_inventory

Stock for an item whose inventory is tracked on a variant.

No

get_kit

A product kit, or bill of materials.

No

list_bulk_prices and get_bulk_price

Quantity-break price tiers.

No

find_by_alternate_id

Finds a record by barcode, GTIN or UPC.

No

list_alternate_id_types and get_alternate_id_type

The catalog of alternate ID types.

No

get_catalog_record

Reads any catalog record by ID, whatever its type: product, variant, category, inventory, kit, option, unit and more.

No

External IDs

An external ID links an iPaaS.com record to its counterpart in a connected system.

Tool

What it does

Changes data?

lookup_product_external_id

Finds a record's ID in a connected system, starting from the iPaaS.com ID.

No

lookup_product_ipaas_id

Finds the iPaaS.com record for an ID from a connected system.

No

find_unmapped_products

Lists catalog records that don't yet have an external ID in a given system.

No

set_product_external_id

Creates or updates the link between a catalog record and an external ID.

Yes (preview first)

delete_product_external_id

Removes that link.

Yes (preview first)

Create, change and remove

Tool

What it does

Changes data?

create_catalog_record, update_catalog_record, delete_catalog_record, reactivate_catalog_record

Create, change, remove or restore a product record of any type. You say which type it is. Deleting is a soft delete, and reactivate brings the record back.

Yes (preview first)

create_catalog_records

Creates up to 25 records of one type in a single call. Every record is checked before any is sent, and the result reports each one. There is no rollback if some fail. Useful when creating data for testing.

Yes (preview first)

create_location_child, update_location_child, delete_location_child, reactivate_location_child

Create, change, remove or restore a location's addresses and relationships.

Yes (preview first)

Good to know

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

  • Updates replace the whole record. The tool fetches the current record and merges your change in, and the preview lists any value that would be cleared.

  • Ask what a write needs first. Ask the assistant what the platform requires for a new record. It can show the required fields and allowed values.

  • Variants carry one value per option. A variant that repeats an option is caught in the preview.

  • Deleted records are left out of searches unless you ask for them.

  • External IDs are never created without your confirmation.

Permissions

Give your key View on Product, Product Variant, Product Category, Product Category Set, Product Inventory, Product Variant Inventory, Location, Product Kit, Product Option, Product Unit, Related Product and External Id to read. For alternate IDs, add Alternate Id Type, Product Alternate Id and Product Variant Alternate Id. Add Create, Edit or Delete only for the changes you want to make, plus Product Custom Field if you work with custom fields. 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?