Skip to content
Sqquid

Account and setup tools

Use these tools at the start of a Sqquid session. They identify the Account and show its setup state.

Identify the authorized user, Organization, Account, OAuth scopes, and AI client.

Requires account:read. Read-only.

No input is required.

The result contains:

  • the Sqquid user
  • the Organization
  • the selected Account and its experience code
  • the approved scopes
  • the authorized AI client

Call this tool first. All operational tools act on the returned Account.

Read the subscription status for the selected Account and other accessible Accounts in the Organization.

Requires account:read. Read-only.

No input is required.

Read has_active_plan before you start paid or setup work. The result also shows the plan code, subscription status, billing period end, and scheduled cancellation state.

The tool can list other accessible Accounts. It does not change the Account for the current authorization.

For invoices, payment details, plan changes, or cancellation in the app, use Settings > Billing.

Read the current plan and usage.

Requires account:read. Read-only.

No input is required.

The result contains usage and allowances for:

  • Connections
  • locations
  • orders in the current monthly period.

Call this tool before you create a Connection or location.

Source Connections do not use the Connection allowance. Commerce, marketplace, and service Connections use the allowance.

Show available plans and start a subscription.

Requires account:write. The user starts the subscription on Stripe.

Input Required Description
plan_code No Plan code from an earlier account_setup result. Omit it to list plans.
payment_method No cc for a card or ach for a US bank account. The default is cc.

Use this sequence:

  1. Call the tool without plan_code.
  2. Show the plan names, prices, features, and limits to the user.
  3. Ask the user to select a plan.
  4. Call the tool with the selected plan_code.
  5. Show the Stripe Checkout request to the user.
  6. Wait for the user to complete checkout.
  7. Call the tool again with the same arguments.
  8. Continue when the result status is active.

The result status can be:

  • choose_plan: Ask the user to select a plan.
  • active: The Account has an active plan.
  • contact_sales: The selected Enterprise plan requires help from Sqquid.

The checkout request expires after 30 minutes. Call the tool again to get a new link.

Read the live Setup Guide for the Account.

Requires account:read. Read-only.

No input is required.

The result contains seven setup goals:

  1. Connect the product source.
  2. Create or import locations.
  3. Connect a sales Connection.
  4. Import inventory and products.
  5. Set up order routing.
  6. Connect shipping.
  7. Add Dynamic Buffers.

Each open goal can contain blockers, suggested MCP tools, and a link to the Sqquid app.

The required goals are the product source, locations, and one sales Connection. The other goals are recommended or optional.

This tool reports setup state. It does not skip or complete a goal.