Skip to main content

Quick Start

Use this guide to publish your first AI widget that can answer questions and call your API.

Before You Begin​

You need:

  • An InstaMCP account.
  • An OpenAPI or Swagger document for the API you want to connect.
  • The base URL of the API, if it is not already included in the OpenAPI document.
  • Any API credentials, headers, or tokens required by your API.

Enterprise customers may also need provider keys or private deployment settings. If those fields are not available in your workspace, contact support.

Step 1: Configure Settings​

Open Settings.

  • Subscription users usually use InstaMCP-managed provider access.
  • Custom or enterprise users may need to add provider keys, model choices, or indexing settings.

See Settings.

Step 2: Create a Bridge​

Open Bridge and choose New Bridge.

Enter:

  • Bridge name.
  • OpenAPI URL, or paste raw OpenAPI JSON.
  • Target API base URL, if needed.

After creation, InstaMCP reads your API description and prepares available tools.

See Bridges.

Step 3: Configure API Authentication​

Choose the auth method your API expects:

  • Bearer token.
  • API key header.
  • OAuth2.
  • Custom headers.
  • Double-hop authentication for logged-in end users.

See Authentication and Headers and Double-Hop Authentication.

Step 4: Review Tools​

Review the generated tools before deployment.

Check:

  • Tool names are understandable.
  • Descriptions explain when to use each tool.
  • Required arguments are clear.
  • Unsafe or unnecessary tools are disabled.

See Tools.

Step 5: Deploy the MCP​

Deploy the bridge so InstaMCP can call the selected tools.

After deployment, test the bridge from the dashboard before exposing it to end users.

See Deployments.

Step 6: Create an Integration​

Open Integrations and create an integration.

Choose:

  • The bridge or deployment to attach.
  • Model.
  • System instructions.
  • Allowed domains.
  • Optional features such as voice, canvas, knowledge base, host actions, and correction memory.

See Integrations and Widgets.

Step 7: Install the Widget​

Copy the widget snippet from the integration page and add it to your website or app.

See Installing the Widget.

Step 8: Verify​

Ask the widget a real customer question.

Confirm that:

  • The widget loads only on allowed domains.
  • The answer uses the correct integration configuration.
  • API tools run successfully.
  • Double-hop auth works if your API requires the visitor's identity.
  • Correction Memory is enabled if you want the AI agent to learn from approved corrections.
  • Usage appears in the usage pages.