Skip to content

MCP tools

This page is for anyone connecting an AI assistant to Monaiq: it lists the tools the assistant gets at the Monaiq MCP endpoint.

Tool What it does
getting_started Onboarding for the business domain and tool usage.
profile View and manage the seller’s own profile, retrieve credentials, read or accept terms, set billing rules, and register the customer sign-in that lets a signed-in customer claim a free license without an emailed code. Viewing the profile returns platformPlan, payouts (state, line, outstanding, the count of what is still needed, deadline and portalUrl), canSell and notices. The account API key is shown to owners of the account only; a member’s response carries none.
account List the accounts you belong to and which one this connection is acting as, or switch to another.
rotate_api_key Regenerate the API key. Owners only, and it takes confirm="rotate". The old key keeps authenticating for overlapHours (default 24, 0 to 168; 0 stops it immediately), and previousKeyExpiresUtc says when it stops; license codes and your sign-in are untouched. An optional label names the new key, such as prod-backend, and your license history shows changes made with it as “by key prod-backend”.
product Catalog CRUD for products: create, update, delete, get, list.
product_feature Catalog CRUD for product features (access gate, rate limit, allowance or limit): create, update, delete, get, list.
offering Catalog CRUD for offerings: create, update, delete, get, describe, list.
feature_offering Catalog CRUD for feature-offering links: create, update, delete, get, list. An allowance of 0 is no cap; a limit with no number is unlimited and needs SDK 2.4.0 or later.
implement_base Guidance and snippets for SDK integration. Does not edit files.
implement_product_feature Guidance and snippets for integrating a product feature. Does not edit files.
implement_purchase_flow Guidance and snippets for the embedded purchase flow. Does not edit files.
get_platform_manifest Returns the full JSON manifest for a supported platform.
provision_api_key_config Returns the exact commands and file edits to plumb the API key into a project. Owners only.
fetch_step_resources Retrieves resources for an implementation step.
monaiq_journal Reads and writes entries in the implementation journal.

On the four catalog tools, a create mints its own id: an Id you supply is ignored, and the response carries the one the server chose. Each takes an optional idempotencyKey (a unique token of up to 128 characters); a repeated call with the same key within five minutes returns the cached response instead of running again.

Tools carry no credential parameters. Sign-in happens once at the MCP client level, using OAuth: the URL is the entire setup. See Connect over MCP for how sign-in works.

A person can belong to more than one Monaiq account. Every tool acts as the one you signed into most recently, with nothing to configure. account list shows the accounts you belong to and which one is in use; account switch with accountId set to an account’s clientId makes it the one in use from your next call on. The portal’s account switcher and this one move the same thing, so whichever you used last is where both land.

An invitation into another account never blocks you: you keep acting as the account you have, and account list names the invitation waiting. Accepting or declining happens in the portal.

Your role is per account, so an owner-only tool answers according to the account in use: you may own one account and be a member of another.

MCP serves catalog authoring and integration guidance. Licenses, seats and license codes are managed through the HTTP management API and the portal, where a change that moves money is confirmed by a person.

  • Customer management
  • Licenses, seats and license codes
  • Invoice operations
  • Consumption analytics