Connection tools
A Connection links a Sqquid Account to an external system. A Connection can be a product source, sales channel, marketplace, or service.
Call connections_catalog before you add a Connection. Call connections_list before you change an existing Connection.
Current integration support
Section titled “Current integration support”The available integrations depend on the Account type and its existing Connections. connections_catalog is the authoritative source.
The MCP server supports browser authorization for:
- Lightspeed Retail X-Series
- Shopify
- Shopify Channels Hub, coming soon
- BigCommerce
- TikTok Shop
- Walmart
- Amazon
- Google Shopping
- eBay
The MCP server supports credential-based creation for:
- RunIt POS
- EasyPost
- WooCommerce
- Salesforce Commerce
- NetSuite
- Magento
Editable settings are available for the integrations above. They are also available for existing Loyverse Connections.
Readiness checks are available for the integrations above, except Amazon and Walmart. They are also available for existing Loyverse Connections.
Discover and inspect Connections
Section titled “Discover and inspect Connections”connections_list
Section titled “connections_list”List every Connection in the Account.
Requires connections:read. Read-only.
No input is required.
The result contains each Connection ID, name, integration, role, enabled state, and latest synchronization information.
Use the returned Connection IDs with other tools.
connections_get
Section titled “connections_get”Read one Connection and its operational state.
Requires connections:read. Read-only.
| Input | Required | Description |
|---|---|---|
connection_id |
Yes | Connection ID from connections_list. |
The result contains:
- Connection identity and role
- enabled state
- enabled import and export features
- last successful synchronization time
- most recent synchronization job and error
- readiness state
The tool does not return credentials or tokens.
Use last_sync to monitor new work. Compare the job type and start time with your request; the latest job may be an older run or a different kind of sync.
connections_catalog
Section titled “connections_catalog”List integrations that can be added to the Account.
Requires connections:read. Read-only.
No input is required.
For each integration, read:
name, which other Connection tools acceptauth, which selects the setup methodsupported, which shows whether MCP can complete setuprequired_fields, which lists credential fieldsneeds_shop, which identifies Shopify flowsneeds_store, which identifies BigCommerce flows
If supported is false, add the Connection in the Sqquid app.
Add a Connection
Section titled “Add a Connection”connections_create
Section titled “connections_create”Create a credential-based Connection.
Requires connections:write. Changes data immediately.
| Input | Required | Description |
|---|---|---|
integration |
Yes | Integration name from connections_catalog. |
name |
No | Connection name in Sqquid. The integration display name is the default. |
credentials |
Yes | Values that use the keys from required_fields. |
The tool creates the Connection in a disabled state. It then returns the readiness result.
Call account_limits before this tool. The plan limit applies to commerce, marketplace, and service Connections.
The tool never returns credentials.
RunIt POS uses the Store ID and API URL as its identity. If that RunIt store already exists, the tool returns the existing Connection.
connections_connect
Section titled “connections_connect”Add a Connection through provider authorization in a browser.
Requires connections:write. The provider authorization creates the Connection.
| Input | Required | Description |
|---|---|---|
provider |
Yes | Provider name from connections_catalog. |
shop |
For Shopify | Shopify shop name or myshopify.com address. |
store |
For BigCommerce | Store hash or full control-panel address. |
Use this sequence:
- Call
connections_catalog. - Confirm that
authisoauthandsupportedistrue. - Call
connections_connect. - Show the returned browser request to the user.
- Wait for the user to approve Sqquid in the provider.
- Call
connections_connectagain with the same arguments. - Read
readinessandnext_toolsfrom the result.
The browser request expires after 30 minutes. Start the tool again after it expires.
If the matching Connection already exists, the tool returns already_connected.
Configure and enable a Connection
Section titled “Configure and enable a Connection”connections_settings
Section titled “connections_settings”Read the editable settings for one Connection.
Requires connections:read. Read-only.
| Input | Required | Description |
|---|---|---|
connection_id |
Yes | Connection ID from connections_list. |
The result groups settings into views. Each view contains:
- a view ID
- a label and description
- the complete current values
- the JSON Schema for accepted values.
Read this tool immediately before connections_update_settings.
connections_update_settings
Section titled “connections_update_settings”Replace one settings view.
Requires connections:write. Changes data.
User approval is required.
| Input | Required | Description |
|---|---|---|
connection_id |
Yes | Connection ID from connections_settings. |
view |
Yes | View ID from connections_settings. |
values |
Yes | Complete replacement values that match the view schema. |
Start with the current values. Change only the required fields. Submit the complete values object.
The approval request shows a field-level difference. If no value changed, the tool does not write data.
connections_apply_preset
Section titled “connections_apply_preset”Apply one product field synchronization policy.
Requires connections:write. Changes data.
User approval is required.
| Input | Required | Description |
|---|---|---|
connection_id |
Yes | Sales Connection with a product field matrix. |
preset |
Yes | sqquid_managed or channel_managed. |
sqquid_managed lets Sqquid create and update all supported product fields. Changes on the sales channel can be overwritten.
channel_managed lets Sqquid create listings. Sqquid does not update the existing product fields.
The result includes the previous matrix. Use that matrix with connections_update_settings if you must restore it.
connections_readiness
Section titled “connections_readiness”Check whether a Connection can be enabled.
Requires connections:read. Read-only.
| Input | Required | Description |
|---|---|---|
connection_id |
Yes | Connection ID from connections_list. |
A failed check blocks connections_enable. A warning does not block the tool.
A check can include a settings view or tool that corrects the problem.
connections_enable
Section titled “connections_enable”Enable synchronization for a Connection.
Requires connections:write. Changes data.
User approval is required.
| Input | Required | Description |
|---|---|---|
connection_id |
Yes | Connection ID to enable. |
The tool checks readiness before it asks for approval. Failed readiness checks block the change.
After approval, imports, exports, and other synchronization processes can run.
connections_disable
Section titled “connections_disable”Stop synchronization for a Connection.
Requires connections:write. Changes data.
User approval is required.
| Input | Required | Description |
|---|---|---|
connection_id |
Yes | Connection ID to disable. |
After approval, imports, exports, and synchronization stop for this Connection. Enable the Connection to start them again.
connections_map_locations
Section titled “connections_map_locations”Import or map locations from Lightspeed X or a Shopify source Connection.
Requires connections:write. Changes data.
User approval is required.
| Input | Required | Description |
|---|---|---|
connection_id |
Yes | Lightspeed X or Shopify source Connection ID. |
mode |
No | import_and_create or map. The default is import_and_create. |
map |
For map mode |
Complete list of store_id and provider_location_id pairs. |
Use import_and_create to add missing Sqquid locations and keep existing mappings. The tool respects the Account’s location limit.
Use map to replace the complete map. Any existing pair that is missing from map becomes unmapped. The location stops synchronizing inventory through that Connection.
The approval request lists created, mapped, skipped, and removed locations.
Synchronize from a POS source
Section titled “Synchronize from a POS source”connections_import_inventory
Section titled “connections_import_inventory”Queue a full inventory import from a POS source.
Requires connections:write. Queues background work.
| Input | Required | Description |
|---|---|---|
connection_id |
Yes | Enabled POS source Connection ID. |
The result status is queued. Call connections_get and check last_sync.
connections_import_products
Section titled “connections_import_products”Queue a product import from a POS source.
Requires connections:write. Queues background work.
| Input | Required | Description |
|---|---|---|
connection_id |
Yes | Enabled POS source Connection ID. |
since_hours |
No | Import products changed in the last 1 to 12 hours. Omit it for a full import. |
The result status is queued. Call connections_get and check last_sync.
Use products_export when you must send a product from Sqquid to a sales Connection.