Skip to main content

Tool catalog

Every authenticated client discovers the same authorized catalog. The server exposes 35 data-read tools, 37 action tools, three read-only integration-guidance tools, and five optional presentation tools for compatible hosts: 80 tools in total. Money-moving actions still require exact confirmation; payment details and OTP stay in secure Inttegro Checkout. Each tool below has a stable anchor so endpoint references and workflow guides can link to it directly.

Read tools

Read tools return minimized application data and do not change Inttegro state.

get_country_specifications

Get country specifications

Lists Commerce-supported countries, currencies, payment methods, payout schedules, and onboarding capabilities.

Read

Endpoint: /spec/countries

Sample prompt

Show the supported countries and tell me which currencies and payment methods are available in Ghana.

list_orders

List orders

Lists a bounded page of recent orders with totals and status, excluding customer contact and address data.

Read

Endpoint: /orders/page

Sample prompt

List the 25 most recent orders and summarize which ones still need payment.

get_order

Get order

Gets one order by ID with a minimized, contact-free projection of order, payment, and timing state.

Read

Endpoint: /orders/lookup

Sample prompt

Look up order <ORDER_ID> and summarize its order status, payment status, total, and latest timestamps.

get_balances

Get balances

Gets current balance snapshots by currency with exact familiar-unit amounts and supplemental machine-readable minor units. This tool cannot move funds.

Read

Endpoint: /balances

Sample prompt

Show my current balances by currency and explain available versus pending amounts without moving funds.

list_balance_transactions

List balance transactions

Lists a bounded page of balance activity with related order, payment, and payout IDs and exact familiar-unit amounts.

Read

Endpoint: /balance_transactions/page

Sample prompt

List the latest balance transactions and identify which returned rows explicitly reference payouts.

list_payouts

List payouts

Lists a bounded page of payouts with status, minimized failure detail, destination IDs, and exact familiar-unit amounts.

Read

Endpoint: /payouts/page

Sample prompt

List recent payouts and group them by status, using only the returned page.

get_payout

Get payout

Gets one payout by ID with status, amount, timing, and minimized reconciliation detail. This tool cannot move funds.

Read

Endpoint: /payouts/lookup

Sample prompt

Look up payout <PAYOUT_ID> and summarize its status, amount, destination, and timing.

get_payout_settings

Get payout settings

Gets automatic payout schedule, FX status, and currency-to-destination mappings without changing them.

Read

Endpoint: /payouts/settings

Sample prompt

Show my payout settings and explain which currencies have configured destinations.

list_products

List products

Lists a bounded page of catalog products with status and compact price summaries, excluding custom metadata and fulfillment detail.

Read

Endpoint: /products/page

Sample prompt

List active products and summarize the price ranges returned on this page.

get_product

Get product

Gets one catalog product by ID with a compact, metadata-minimized projection.

Read

Endpoint: /products/lookup

Sample prompt

Look up product <PRODUCT_ID> and show its status and compact price summary.

list_prices

List prices

Lists a bounded page of catalog prices, optionally restricted to one product, with exact familiar-unit amounts.

Read

Endpoint: /prices/page

Sample prompt

List prices for product <PRODUCT_ID> and show active prices in GHS.

get_price

Get price

Gets one catalog price by ID with its amount and compact related-product identity.

Read

Endpoint: /prices/lookup

Sample prompt

Look up price <PRICE_ID> and tell me its amount, currency, active state, and product.

get_payment_method_settings

Get payment method settings

Gets enabled and confirmation-required settings for each payment method type without exposing payment credentials.

Read

Endpoint: /payment_methods/settings

Sample prompt

Show my payment method settings and explain which payment methods require confirmation.

list_customers

List customers

Lists a bounded page of customers with channel availability, countries, and balance summaries. Raw contact and address fields are excluded.

Read

Endpoint: /customers/page

Sample prompt

List recent customers and show which ones have SMS or email channels available.

get_customer

Get customer

Gets one customer by ID using a minimized projection that reports channel availability without exposing raw contact details.

Read

Endpoint: /customers/lookup

Sample prompt

Look up customer <CUSTOMER_ID> and summarize their available channels and balance summary.

list_messages

List messages

Lists recent customer-message delivery statuses. Message bodies, recipients, provider payloads, and delivery addresses are excluded.

Read

Endpoint: /chimes/page

Sample prompt

List recent messages and summarize delivery statuses without exposing message bodies or recipients.

get_message

Get message

Gets the lifecycle status of one customer message without exposing its body or recipient contact details.

Read

Endpoint: /chimes/lookup

Sample prompt

Look up message <CHIME_ID> and tell me its delivery status and timestamps.

list_message_templates

List message templates

Lists a bounded page of reusable SMS and email templates with lifecycle, locale, variable contracts, and version state. Message bodies are excluded.

Read

Endpoint: /message_templates/page

Sample prompt

List published English SMS templates for order updates and show whether any have unpublished changes.

get_message_template

Get message template

Gets one template with editable channel content and version state while withholding variable defaults and private email-header values.

Read

Endpoint: /message_templates/lookup

Sample prompt

Look up message template <MESSAGE_TEMPLATE_ID> and show its editable content, variables, and publication state.

preview_message_template

Preview message template

Renders the current draft with supplied non-secret variables so the merchant can review the actual SMS or email before publishing.

Read

Endpoint: /message_templates/render_preview

Sample prompt

Preview message template <MESSAGE_TEMPLATE_ID> with representative values and show the exact rendered copy.

list_files

List files

Lists bounded file metadata and processing state without returning bytes, checksums, storage details, or unrestricted custom data.

Read

Endpoint: /files/page

Sample prompt

List the latest available invoice files and summarize their type, size, and processing state.

get_file

Get file

Gets safe metadata for one file without returning its bytes or provider and storage internals.

Read

Endpoint: /files/lookup

Sample prompt

Look up file <FILE_ID> and show its safe metadata and availability state.

prepare_order_payment

Prepare order payment

Returns the exact major-unit order total, only masked active payment-method choices, and a trusted secure-checkout URL without exposing payment credentials.

Read

Endpoints: /orders/lookup, /payment_methods/page

Sample prompt

Prepare payment choices for order <ORDER_ID>. Show masked saved methods and let me choose one or secure entry for a new method.

get_refund_options

Get refund options

Returns numbered order lines, exact major-unit paid amounts, existing reservations, and conservative remaining refundable amounts.

Read

Endpoint: /orders/lookup

Sample prompt

Prepare a refund for order <ORDER_ID>. Show me the numbered refundable lines and remaining amounts, then guide me through the choices.

list_refunds

List refunds

Lists a bounded page of refunds with per-line allocations, reasons, timestamps, and lifecycle status.

Read

Endpoint: /refunds/page

Sample prompt

List the latest refunds and distinguish pending, processing, succeeded, failed, and canceled states.

get_refund

Get refund

Gets one refund for authoritative lifecycle reconciliation. Only succeeded means the refund completed.

Read

Endpoint: /refunds/lookup

Sample prompt

Look up refund <REFUND_ID> and tell me whether it actually succeeded, including its exact line allocations.

get_order_analytics

Get order analytics

Compares order volume, paid orders, cancellations, expirations, and gross sales for a 7, 30, or 90 day period with exact daily values and a Flint chart.

Read

Sample prompt

Show order analytics for the last 30 days in GHS, including exact daily values and the chart.

get_product_analytics

Get product analytics

Ranks products or inspects one product by paid orders, units sold, and gross revenue for a selected period and currency.

Read

Sample prompt

Rank products by gross revenue over the last 30 days in GHS and include paid orders and units sold.

get_customer_analytics

Get customer analytics

Ranks customers or inspects one customer by paid orders and gross revenue, alongside the exact new-customer count for the period.

Read

Sample prompt

Show the top customers for the last 90 days in GHS without exposing contact details.

get_payout_analytics

Get payout analytics

Compares payout starts, successes, failures, cancellations, lateness, and exact requested, disbursed, and failed amounts.

Read

Sample prompt

Show payout performance for the last 30 days in GHS, including exact lifecycle counts, the disbursed amount in major units, and the chart.

get_message_analytics

Get message analytics

Compares initialized, delivered, and failed customer-message activity, including a clearly labeled delivered-to-initialized period ratio, without message bodies or contact details.

Read

Sample prompt

Show customer-message delivery performance for the last 30 days, including exact counts, rate, and the chart.

Action tools

Every action requires a caller-generated printable operation key of at most 60 characters and MCP form confirmation.

create_customer

Create customer

Creates a customer with optional contact and delivery details. Sensitive input is sent only to Commerce and is not echoed in the result.

Confirmed action

Endpoint: /customers/create

Sample prompt

Create a customer named <NAME> with the provided phone and email. Ask me to confirm before creating it.

create_customer_from_contact

Create customer from contact

Creates a customer from contact data explicitly selected in the host, resolving any name, email, phone, or address alternatives before confirmation. The MCP cannot browse an address book.

Confirmed action

Endpoint: /customers/create

Sample prompt

Create an Inttegro customer from the contact I selected. Let me resolve any alternatives and confirm before creating it.

update_customer

Update customer

Updates selected customer identity, contact, or delivery fields without returning raw contact or address data.

Confirmed action

Endpoint: /customers/update

Sample prompt

Update customer <CUSTOMER_ID> with the new display name <NAME>. Ask me to confirm before changing it.

create_order

Create order

Creates an order for an existing customer from catalog product and price IDs. This tool never executes payment; finalize defaults to false.

Confirmed action

Endpoints: /orders/create, /orders/new

Sample prompt

Create and finalize an order for customer <CUSTOMER_ID> with product <PRODUCT_ID> and price <PRICE_ID>. Do not execute payment.

update_order

Update order

Updates selected mutable order fields. A supplied line-item list replaces the complete set; payment configuration and execution are excluded.

Confirmed action

Endpoint: /orders/update

Sample prompt

Update order <ORDER_ID> with the supplied order number. Ask me to confirm the exact changed fields first.

finalize_order

Finalize order

Seals a draft order without executing payment.

Confirmed action

Endpoint: /orders/finalize

Sample prompt

Finalize order <ORDER_ID> without executing payment. Ask me to confirm before sealing it.

complete_order

Complete order

Marks an eligible fulfilled order complete without marking an offline payment.

Confirmed action

Endpoint: /orders/complete

Sample prompt

Mark fulfilled order <ORDER_ID> complete. Do not mark it paid out of band, and ask me to confirm first.

cancel_order

Cancel order

Cancels an eligible order without requesting or executing a refund.

Confirmed action

Endpoint: /orders/cancel

Sample prompt

Cancel order <ORDER_ID> for the stated reason. Do not request a refund, and ask me to confirm first.

pay_order

Pay order

Starts or deliberately retries a real payment after a masked method choice and exact confirmation. New details and OTP stay in secure Inttegro Checkout.

Confirmed action

Endpoints: /orders/lookup, /payment_methods/page, /orders/pay

Sample prompt

Prepare payment for order <ORDER_ID>, let me select a masked saved method or new secure entry, and confirm the exact amount before charging.

create_refund

Create refund

Creates an asynchronous line-item refund from exact major-unit decimal amounts after refreshing availability and confirming every amount, per-line reason, and required overall reason.

Confirmed action

Endpoints: /orders/lookup, /refunds/create

Sample prompt

Guide me through refunding order <ORDER_ID>: affected lines, exact amount per line, optional line reasons, and the required overall reason. Confirm the complete summary before creating it.

cancel_refund

Cancel refund

Attempts to cancel a still-pending refund after confirming its current amount, order, and reason.

Confirmed action

Endpoints: /refunds/lookup, /refunds/cancel

Sample prompt

Cancel pending refund <REFUND_ID>. Show its current amount and reason, then ask me to confirm before attempting cancellation.

send_order_invoice

Send order invoice

Sends a finalized order invoice through the order customer’s available delivery channels after confirmation.

Confirmed action

Endpoint: /orders/send_invoice

Sample prompt

Send the invoice for order <ORDER_ID> through available customer channels. Ask me to confirm first.

send_order_receipt

Send order receipt

Generates and delivers the receipt for a paid order through configured customer channels after confirmation.

Confirmed action

Endpoint: /orders/send_receipt

Sample prompt

Send the receipt for paid order <ORDER_ID> and report which channels succeeded or failed.

send_customer_sms

Send customer SMS

Sends one SMS of at most 120 characters to an existing customer. Arbitrary phone numbers, broadcasts, and schedules are not accepted.

Confirmed action

Endpoint: /chimes/send

Sample prompt

Send customer <CUSTOMER_ID> the exact SMS “Your order is ready for pickup.” Ask me to confirm first.

create_message_template

Create message template

Creates one reusable SMS or email draft with a typed variable contract. Creation does not publish or send it.

Confirmed action

Endpoint: /message_templates/create

Sample prompt

Create an SMS order-ready template with customer_name and order_number variables, but leave it as a draft for review.

update_message_template

Update message template

Creates a new draft version of a template without silently replacing the version currently used for sends.

Confirmed action

Endpoint: /message_templates/update

Sample prompt

Update message template <MESSAGE_TEMPLATE_ID> with this revised copy, then show that it has unpublished changes.

publish_message_template

Publish message template

Publishes the reviewed draft for future Chime sends after separate confirmation.

Confirmed action

Endpoint: /message_templates/publish

Sample prompt

Preview message template <MESSAGE_TEMPLATE_ID>, let me approve the rendered result, then publish it.

archive_message_template

Archive message template

Archives a template so it cannot be updated, published, previewed, or selected for new sends.

Confirmed action

Endpoint: /message_templates/archive

Sample prompt

Archive message template <MESSAGE_TEMPLATE_ID> and explain the consequence before asking me to confirm.

send_customer_template

Send customer template

Renders and validates a published template, shows the actual customer-facing copy for confirmation, and sends it once to a saved customer by explicit SMS or email transport. Draft-divergent templates are refused.

Confirmed action

Endpoints: /message_templates/render_preview, /chimes/send

Sample prompt

Send published template <MESSAGE_TEMPLATE_ID> to customer <CUSTOMER_ID> by SMS with these variables. Show me the exact rendered message before sending.

create_product

Create product

Creates a catalog product as a draft by default. Prices are created separately so each operation has an unambiguous result.

Confirmed action

Endpoint: /products/create

Sample prompt

Create a draft service product named “Consultation” with the given description. Ask me to confirm before creating it.

update_product

Update product

Updates reviewed descriptive product fields without changing price, media, fulfillment, or unrestricted metadata.

Confirmed action

Endpoint: /products/update

Sample prompt

Update product <PRODUCT_ID> with this description and ask me to confirm the changed field.

publish_product

Publish product

Publishes a product to customer-facing catalog and checkout flows.

Confirmed action

Endpoint: /products/publish

Sample prompt

Publish product <PRODUCT_ID> and ask me to confirm that it will become customer-facing.

unpublish_product

Unpublish product

Hides a product from new customer-facing catalog selection without archiving it.

Confirmed action

Endpoint: /products/unpublish

Sample prompt

Unpublish product <PRODUCT_ID> so it is hidden from new selection. Ask me to confirm first.

archive_product

Archive product

Archives and deactivates a product while retaining its historical record.

Confirmed action

Endpoint: /products/archive

Sample prompt

Archive product <PRODUCT_ID> and explain the consequence before asking me to confirm.

create_product_price

Create product price

Creates an active price for an existing product. Supply an exact decimal amount in familiar major currency units; the MCP converts it safely.

Confirmed action

Endpoint: /products/add_price

Sample prompt

Create a GHS 350.00 price for product <PRODUCT_ID> and ask me to confirm first.

update_price

Update price

Updates price label or description only. Amount, currency, and product association remain immutable.

Confirmed action

Endpoint: /prices/update

Sample prompt

Update price <PRICE_ID> with this label. Keep amount and currency unchanged, and ask me to confirm first.

activate_price

Activate price

Reactivates an eligible price for new catalog and checkout flows.

Confirmed action

Endpoint: /prices/activate

Sample prompt

Activate price <PRICE_ID> for new checkout use and ask me to confirm first.

deactivate_price

Deactivate price

Deactivates a price so it cannot be selected in new active catalog flows.

Confirmed action

Endpoint: /prices/deactivate

Sample prompt

Deactivate price <PRICE_ID> for new use and ask me to confirm first.

archive_price

Archive price

Archives a price permanently for new use while retaining historical references.

Confirmed action

Endpoint: /prices/archive

Sample prompt

Archive price <PRICE_ID> and explain that it cannot be reactivated before asking me to confirm.

upload_file

Upload file

Uploads canonical base64 file content up to 5 MiB and returns safe file metadata without echoing bytes or unrestricted custom data.

Confirmed action

Endpoint: /files/upload

Sample prompt

Upload this selected PDF as an invoice file and ask me to confirm the filename, type, and size first.

delete_file

Delete file

Tombstones a file and requests backing-content cleanup subject to its owning reference policy.

Confirmed action

Endpoint: /files/delete

Sample prompt

Delete file <FILE_ID> and explain the retention consequence before asking me to confirm.

Integration guidance tools

Guidance tools turn architecture choices into implementation and testing instructions. They are read-only and never accept credentials.

design_integration

Design Inttegro integration

Elicits the integration goal, server runtime, SDK preference, and checkout approach, then returns an agent-ready build and test plan without accepting credentials.

Integration guidance

Sample prompt

Help me design our Inttegro integration. Ask whether we should use an SDK and Inttegro Checkout, then give my agent exact build and test instructions.

get_integration_guide

Get integration guide

Returns a focused implementation sequence and canonical Studio links for authentication, checkout, orders, catalog, messaging, idempotency, or testing.

Integration guidance

Sample prompt

Give my agent the Inttegro hosted-checkout integration guide and canonical documentation links.

check_integration_readiness

Check integration readiness

Audits secret handling, idempotency, errors, state verification, checkout returns, and messaging consent without receiving source code or credentials.

Integration guidance

Sample prompt

Check whether our hosted-checkout integration is ready for an end-to-end test and list every blocker.

Presentation tools

Compatible hosts may use presentation tools to render unchanged business results visually. They do not add authority, fetch hidden data, or replace structured results.

render_order_card

Render order card

Presents an already-fetched order as a compact visual status card. It does not fetch or mutate the order.

Presentation

Sample prompt

After looking up order <ORDER_ID>, render it as a compact order card.

render_analytics_dashboard

Render analytics dashboard

Presents one order, product, or customer analytics result visually without calculating or altering metrics.

Presentation

Sample prompt

After getting product analytics for the last 30 days in GHS, render the analytics dashboard.

render_product_card

Render product card

Presents one already-fetched product as a visual card with its identity, lifecycle, description, and exact returned prices. It does not fetch or change products or prices.

Presentation

Sample prompt

After looking up product <PRODUCT_ID>, render the unchanged result as a product card.

How analytics works

Use analytics tools when you want totals, rankings, or trends. They read from Inttegro's reporting data instead of adding up whatever happens to appear on a paginated list page. That distinction matters: a list tool returns a page of recent records, not the complete history for your account.

When an analytics tool returns money, it presents an exact major-unit decimal with the currency, such as GHS 350.00. Supplemental integer minor-unit fields remain available for machine consumers. Currencies are reported separately, and if part of a period is unavailable, the tool marks the result as empty or partial instead of filling the gap with a guess.

Deliberate boundaries

The catalog does not:

  • accept raw payment credentials or OTP in chat;
  • mark an asynchronous refund complete before its status is succeeded;
  • move balances or change payout settings;
  • expose customer phone numbers, email addresses, street addresses, payment credentials, or unrestricted custom metadata;
  • send to arbitrary phone numbers, broadcast, or schedule messages;
  • use repeated single-message calls as a bulk outreach mechanism; or
  • proxy arbitrary Commerce API operations.

See merchant workflows for examples that combine these tools safely.

To have an agent choose an SDK and checkout architecture, produce a build brief, and check test readiness, see the design_integration guide and Build an integration with an agent.