Skip to main content
POST
/
v1
/
ui
/
products
/
mcp
/
bootstrap
Bootstrap MCP product integration for UI
curl --request POST \
  --url https://api.example.com/v1/ui/products/mcp/bootstrap \
  --header 'Content-Type: application/json' \
  --data '
{
  "originUrl": "<string>",
  "metadata": {},
  "name": "<string>",
  "description": "<string>",
  "imageUrl": "<string>",
  "productType": "<string>",
  "mcpDomain": "<string>",
  "authHeaderName": "<string>",
  "authApiKey": "<string>",
  "plans": [
    {
      "key": "<string>",
      "name": "<string>",
      "price": 1,
      "currency": "<string>",
      "billingCycle": "weekly",
      "type": "recurring",
      "creditsPerUnit": 123,
      "billingModel": "pre-paid",
      "freeUnits": 1,
      "limit": 1,
      "features": {}
    }
  ],
  "tools": [
    {
      "name": "<string>",
      "description": "<string>",
      "noPlan": true,
      "planKeys": [
        "<string>"
      ]
    }
  ]
}
'
{
  "product": {
    "reference": "prd_1A2B3C4D",
    "name": "AI Writing Assistant",
    "status": "active",
    "balance": 0,
    "totalTransactions": 0,
    "isMcpPay": false,
    "createdAt": "<string>",
    "updatedAt": "<string>",
    "description": "<string>",
    "imageUrl": "<string>",
    "productType": "<string>",
    "config": {
      "fulfillmentType": "digital",
      "validityPeriod": 30,
      "deliveryMethod": "api"
    },
    "metadata": {},
    "plans": [
      {
        "reference": "pln_1A2B3C4D",
        "price": 2999,
        "currency": "USD",
        "requiresPayment": true,
        "isActive": true,
        "status": "active",
        "createdAt": "<string>",
        "updatedAt": "<string>",
        "currencySymbol": "$",
        "setupFee": 500,
        "trialDays": 14,
        "billingCycle": "monthly",
        "billingModel": "pre-paid",
        "creditsPerUnit": 1,
        "measures": "requests",
        "meterRef": "mtr_1A2B3C4D",
        "limit": 10000,
        "rolloverUnusedUnits": false,
        "freeUnits": 1000,
        "limits": {},
        "features": {}
      }
    ],
    "mcp": {
      "mcpServerRef": "mcp_ABC123",
      "mcpSubdomain": "acme-docs",
      "mcpProxyUrl": "https://acme-docs.mcp.solvapay.com/mcp",
      "originUrl": "https://origin.example.com/mcp",
      "defaultPlanRef": "pln_FREE123"
    }
  },
  "mcpServer": {
    "reference": "mcp_ABC123",
    "subdomain": "acme-docs",
    "mcpProxyUrl": "https://acme-docs.mcp.solvapay.com/mcp",
    "url": "https://origin.example.com/mcp",
    "defaultPlanRef": "pln_FREE123"
  },
  "planMap": {
    "free": {
      "reference": "pln_FREE123",
      "name": "Free"
    }
  },
  "toolsAutoMapped": true,
  "autoMappedTools": [
    {
      "name": "<string>",
      "description": "<string>"
    }
  ]
}

Body

application/json
originUrl
string<uri>
required
Minimum string length: 1
metadata
object
required
name
string
description
string
imageUrl
string
productType
string
mcpDomain
string
authHeaderName
string
authApiKey
string
plans
object[]
tools
object[]

Response

MCP product bootstrapped successfully

product
object
required

Created product

mcpServer
object
required

Created or updated MCP server identity

Example:
{
"reference": "mcp_ABC123",
"subdomain": "acme-docs",
"mcpProxyUrl": "https://acme-docs.mcp.solvapay.com/mcp",
"url": "https://origin.example.com/mcp",
"defaultPlanRef": "pln_FREE123"
}
planMap
object
required

Resolved plan mapping by bootstrap key

Example:
{
"free": {
"reference": "pln_FREE123",
"name": "Free"
}
}
toolsAutoMapped
boolean

True when tools were auto-discovered from origin because the request omitted tools

Example:

true

autoMappedTools
object[]

Auto-discovered tools used during bootstrap