Build multi-tenant apps over MCP. Schemas, CRUD, deploys — access control enforced server-side.
Maintain this server? Claim it
Call this server's tools from your browser. Nothing to install.
Supero project API key (ak_...). Create one at app.supero.dev under your project's API keys. The key carries its own scope: every tool call is evaluated against the roles attached to it.
Requests go through mcptry because browsers can't call most MCP servers directly. Header values are sent to the server for that request only and are never stored or logged.
Tool list from our last check. Connect live to refresh it.
Get the scope and permissions of the current API key.
This tool takes no arguments.
Get the scope and permissions of the current API key.
No arguments.
{
"type": "object",
"properties": {}
}Bind source streams to the app's schemas. mode='live_read' (default: read-only BYODB / warehouse), 'live_readwrite' (BYODB read+write — DOMAIN-ADMIN only), or 'sync' (copy into SuperoDB). For live modes, discovery must have run and each binding's `source` must match a discovered stream; the bind VERIFIES the live mapping materialized. Bound live schemas are read/written via ORDINARY app CRUD — nothing goes in the bundle.
| Argument | Type | Description |
|---|---|---|
| bindings* | array | One entry per app schema to back with a source stream. |
| connector_id* | string | The connector to bind (from build_connect_data_source). |
{
"type": "object",
"required": [
"connector_id",
"bindings"
],
"properties": {
"bindings": {
"type": "array",
"items": {
"type": "object",
"required": [
"schema",
"source"
],
"properties": {
"mode": {
"enum": [
"live_read",
"live_readwrite",
"sync"
],
"type": "string",
"description": "live_read (default, read-only), live_readwrite (domain-admin key only), or sync (copy into SuperoDB)."
},
"schema": {
"type": "string",
"description": "App schema name to back."
},
"source": {
"type": "string",
"description": "Source stream/table (must match a discovered stream for live modes)."
},
"stream_class": {
"enum": [
"entity",
"event"
],
"type": "string",
"description": "'entity' = mutable business records (current-state rows, e.g. customers/products); 'event' = append-only time-series/log rows (e.g. clicks, sensor readings). OMIT it to let the platform classify safely from the stream's shape — only set it to override."
},
"tenant_binding": {
"type": "object",
"description": "How live rows map to Supero tenants. OMIT for the default {mode:'fixed', tenant:'default-tenant'} (all rows visible to the default tenant/admin — required, else live reads 403 tenant_binding_missing). For per-tenant isolation pass {mode:'column', tenant_field:'<col>', tenant_value_map:{<supero_tenant>:<source_value>}}."
}
}
},
"description": "One entry per app schema to back with a source stream."
},
"connector_id": {
"type": "string",
"description": "The connector to bind (from build_connect_data_source)."
}
}
}Configure a service's keys for the project so an integration works at deploy (e.g. wire SendGrid for email, a Stripe TEST key for checkout). TEST/SANDBOX keys ONLY. Keys with a clear live marker (Stripe sk_live_… / Razorpay rzp_live_…) are auto-refused, but most providers give NO test-vs-live signal — so for EVERY provider send test/sandbox keys only and use the admin panel for production secrets (a deep link is returned). Never put a real secret through this tool/chat. Reacts to the live permission result; secret values are never echoed.
| Argument | Type | Description |
|---|---|---|
| config* | object | Test/sandbox config key→value (e.g. {"sendgrid_api_key":"SG.test…"}). Live-marked keys refused; send test keys only. |
| service_id* | string | Catalog id (e.g. 'stripe_checkout', 'email'). |
| project_uuid* | string | Project UUID (from build_list_projects or build_create_project). |
{
"type": "object",
"required": [
"project_uuid",
"service_id",
"config"
],
"properties": {
"config": {
"type": "object",
"description": "Test/sandbox config key→value (e.g. {\"sendgrid_api_key\":\"SG.test…\"}). Live-marked keys refused; send test keys only."
},
"service_id": {
"type": "string",
"description": "Catalog id (e.g. 'stripe_checkout', 'email')."
},
"project_uuid": {
"type": "string",
"description": "Project UUID (from build_list_projects or build_create_project)."
}
}
}Create a data connector to an EXTERNAL source the app owner controls (their own database, a REST API, or a warehouse). Returns a connector_id. Does NOT bind schemas yet — run build_discover_source then build_bind_data_source. Credentials are sent to the platform and NEVER echoed back; prefer read-only DB creds / the Key Store for production. Requires a domain- or project-admin API key.
| Argument | Type | Description |
|---|---|---|
| auth | object | api kind: {type: none|api_key|bearer|basic|oauth2, ...}. |
| host | string | Server hostname (database kinds, Fabric, ClickHouse, Snowflake, Databricks). BigQuery/Redshift take their connection settings in `config`. |
| kind* | string | Source kind. |
| name* | string | Connector name (unique within the project). |
| port | integer | Server port; omit for the dialect default (5432 PostgreSQL, 3306 MySQL, 1433 MSSQL/Fabric, 1521 Oracle, 27017 MongoDB). |
| config | object | Extra source config (e.g. warehouse account). |
| db_type | string | database/warehouse: postgresql|mysql|mssql|oracle|mongodb|snowflake|bigquery|redshift|databricks|clickhouse|fabric. |
| base_url |
Create a NEW project (domain-admin keys only; plan-gated). Mints the project's schema_namespace + an API key (returned ONCE). Use for a fresh app.
| Argument | Type | Description |
|---|---|---|
| name* | string | Project name/slug. |
| description | string | Optional: what the app is for — persisted on the project so future sessions build to it. |
| display_name | string | Optional human-readable name shown in the dashboard. |
| requirements | array | Optional: the confirmed requirements/plan bullets — persisted on the project record (future sessions read them via build_get_project). |
| schema_namespace | string | Optional; server normalizes/derives if omitted. |
{
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"description": "Project name/slug."
},
"description": {
"type": "string",
"description": "Optional: what the app is for — persisted on the project so future sessions build to it."
},
"display_name": {
"type": "string",
"description": "Optional human-readable name shown in the dashboard."
},
"requirements": {
"type": "array",
"items": {
"type": "string"
},
"description": "Optional: the confirmed requirements/plan bullets — persisted on the project record (future sessions read them via build_get_project)."
},
"schema_namespace": {
"type": "string",
"description": "Optional; server normalizes/derives if omitted."
}
}
}Deploy a published version. target='cloud_ephemeral' (managed Cloud Run, ~30m throwaway preview; requires platform enablement; the default when cloud deploy is enabled) or 'local' (hand the user the bundle to run with the project's own key). For a PERMANENT public URL, use build_go_live instead.
| Argument | Type | Description |
|---|---|---|
| target | string | Default 'cloud_ephemeral' when cloud deploy is enabled (else 'local'). |
| app_type | string | Default 'web'. |
| project_uuid* | string | Project UUID (from build_list_projects or build_create_project). |
| version_uuid | string | Default: latest published version. |
{
"type": "object",
"required": [
"project_uuid"
],
"properties": {
"target": {
"enum": [
"local",
"cloud_ephemeral"
],
"type": "string",
"description": "Default 'cloud_ephemeral' when cloud deploy is enabled (else 'local')."
},
"app_type": {
"enum": [
"web",
"all"
],
"type": "string",
"description": "Default 'web'."
},
"project_uuid": {
"type": "string",
"description": "Project UUID (from build_list_projects or build_create_project)."
},
"version_uuid": {
"type": "string",
"description": "Default: latest published version."
}
}
}Poll a cloud deploy started by build_deploy or build_go_live. Pass the poll_url it returned. Reports elapsed_s since launch. 'launching' for 5-6.5 minutes is normal (Cloud Run IAM propagation): keep polling every ~30s and probe the url once it appears. Only a persistent unreachable past ~10 minutes is a real failure (see the anti-loop rules).
| Argument | Type | Description |
|---|---|---|
| poll_url* | string | The poll_url returned by build_deploy or build_go_live. |
| permanent | boolean | Set true when polling a build_go_live (permanent) deploy so the expiry guidance is correct. Default: auto-detected. |
{
"type": "object",
"required": [
"poll_url"
],
"properties": {
"poll_url": {
"type": "string",
"description": "The poll_url returned by build_deploy or build_go_live."
},
"permanent": {
"type": "boolean",
"description": "Set true when polling a build_go_live (permanent) deploy so the expiry guidance is correct. Default: auto-detected."
}
}
}Discover a connector's schema: trigger discovery, wait, and return the source streams (names, columns, primary keys), AI-inferred Supero schemas, field mappings, and a suggested namespace. Run AFTER build_connect_data_source and BEFORE build_bind_data_source (a live bind's `source` MUST equal a discovered stream name).
| Argument | Type | Description |
|---|---|---|
| timeout | integer | Max seconds to wait IN THIS CALL (default 60, cap 90 — an MCP call must finish under the ~100s edge limit). On timeout, resume with the returned execution_id; the job keeps running server-side. |
| connector_id* | string | The connector to discover (from build_connect_data_source). |
| execution_id | string | RESUME polling an in-flight discovery (from a previous timeout error) instead of starting a new job. |
{
"type": "object",
"required": [
"connector_id"
],
"properties": {
"timeout": {
"type": "integer",
"description": "Max seconds to wait IN THIS CALL (default 60, cap 90 — an MCP call must finish under the ~100s edge limit). On timeout, resume with the returned execution_id; the job keeps running server-side."
},
"connector_id": {
"type": "string",
"description": "The connector to discover (from build_connect_data_source)."
},
"execution_id": {
"type": "string",
"description": "RESUME polling an in-flight discovery (from a previous timeout error) instead of starting a new job."
}
}
}PREFLIGHT a bundle BEFORE publish/deploy — catches the silent deploy-killers build_validate does NOT: missing #supero-preloader removal (app stuck on a spinner forever), heavy startup seed (Cloud Run port-bind timeout → 'container failed to start'), reserved field names like status/state (silently dropped), namespace collisions (ambiguous reads), and services needing elevated import permission. Run it after build_validate and before build_publish.
| Argument | Type | Description |
|---|---|---|
| files | object | Map of {relative_path: file_content}. |
| files_ref | string | For a LARGE bundle that exceeds the model output-token cap: a file_id from build_stage_bundle (upload the gzip(json {path:content}) blob out-of-band, then pass its file_id here). Preferred over files/files_b64gz when the bundle will not fit inline. |
| files_b64gz | string | Alt to files: base64(gzip(JSON {path:content})). |
| project_uuid | string | Target project (enables namespace + collision checks). |
{
"type": "object",
"required": [],
"properties": {
"files": {
"type": "object",
"description": "Map of {relative_path: file_content}."
},
"files_ref": {
"type": "string",
"description": "For a LARGE bundle that exceeds the model output-token cap: a file_id from build_stage_bundle (upload the gzip(json {path:content}) blob out-of-band, then pass its file_id here). Preferred over files/files_b64gz when the bundle will not fit inline."
},
"files_b64gz": {
"type": "string",
"description": "Alt to files: base64(gzip(JSON {path:content}))."
},
"project_uuid": {
"type": "string",
"description": "Target project (enables namespace + collision checks)."
}
}
}Fetch the CURRENT (or a given) PUBLISHED bundle: the file list + a signed download_url, or ONE file's content inline via file=. For ANY change request on an existing app, START from this bundle and modify it — re-authoring from scratch silently drops the hand-authored ui/app.js and every prior fix.
| Argument | Type | Description |
|---|---|---|
| file | string | Optional app-root-relative path (e.g. 'ui/app.js') to return that single file's content inline (~120KB cap, truncated with a note). |
| project_uuid* | string | Project UUID (from build_list_projects or build_create_project). |
| version_uuid | string | Default: latest published version. |
{
"type": "object",
"required": [
"project_uuid"
],
"properties": {
"file": {
"type": "string",
"description": "Optional app-root-relative path (e.g. 'ui/app.js') to return that single file's content inline (~120KB cap, truncated with a note)."
},
"project_uuid": {
"type": "string",
"description": "Project UUID (from build_list_projects or build_create_project)."
},
"version_uuid": {
"type": "string",
"description": "Default: latest published version."
}
}
}Fetch a COMPLETE, production-quality reference app (schemas.py + config.py + setup.py + ui/app.js) to copy patterns from — the single biggest lever for app quality. archetype='index' (default) lists the available archetypes with per-file byte sizes; pick the one closest to your app ('commerce-marketplace' | 'service-booking' | 'ops-dashboard' | 'multitenant-portal' | 'saas-billing') and fetch it BEFORE authoring your UI. These are real 'stunning' apps; mirror how they compose the SDK components, art-direct the landing page, and structure schemas. Optional file= to fetch just one file ('schemas.py' | 'config.py' | 'setup.py' | 'ui/app.js'). Responses are PAGED (~32KB/section): when the header says more:true, fetch the next section with offset=<next_offset> — never re-fetch from 0.
| Argument | Type | Description |
|---|---|---|
| file | string | Optional: return only this one file instead of the whole bundle. |
| offset | integer | Byte offset to start from (for paging; default 0). |
| archetype | string | Which reference app (default 'index' to list them). |
| max_bytes | integer | Max bytes to return per section (default ~32000). |
{
"type": "object",
"properties": {
"file": {
"enum": [
"schemas.py",
"config.py",
"setup.py",
"ui/app.js"
],
"type": "string",
"description": "Optional: return only this one file instead of the whole bundle."
},
"offset": {
"type": "integer",
"description": "Byte offset to start from (for paging; default 0)."
},
"archetype": {
"enum": [
"index",
"commerce-marketplace",
"service-booking",
"ops-dashboard",
"multitenant-portal",
"saas-billing"
],
"type": "string",
"description": "Which reference app (default 'index' to list them)."
},
"max_bytes": {
"type": "integer",
"description": "Max bytes to return per section (default ~32000)."
}
}
}Get one project's details: schema_namespace (use this EXACT value as the `namespace` literal on every schema dict), last published version, AND the captured `project_intent` — the brief (project_description/summary), the discovered data model (entities/central_entity/relationships/status_workflows), and the landing intent (public_landing_view). BUILD TO THIS — it's the authoritative app spec the user already gave; don't re-ask or ignore it.
| Argument | Type | Description |
|---|---|---|
| project_uuid* | string | Project UUID (from build_list_projects or build_create_project). |
{
"type": "object",
"required": [
"project_uuid"
],
"properties": {
"project_uuid": {
"type": "string",
"description": "Project UUID (from build_list_projects or build_create_project)."
}
}
}Fetch the AUTHORITATIVE contract for a transactional/stateful platform service (cart, order, payment, booking, appointment, membership, approval, document_signature, recurring_plan, inventory, task, ticket, loyalty_points, rental, comment, attachment, feedback, notification, product, service, customer, workflows). Returns the service's state machine (initial_state + transitions), its operations (op ids + input fields + resulting state), the base schemas + mandatory fields you must supply, AND the platform's DEFAULT UI SCHEMAS for that service — the bulletproof reference for building a correct, sophisticated transactional UI. ALWAYS call this for any service your app `extends` BEFORE authoring its UI — do not guess op names, states, or mandatory fields from prose. service_id='index' (default) lists all services.
| Argument | Type | Description |
|---|---|---|
| parts | string | What to return (default 'both'): 'contract' = state machine/ops/schemas; 'ui_schemas' = default UI only. |
| service_id | string | The service id (e.g. 'cart', 'booking', 'payment'); 'index' (default) lists all. |
{
"type": "object",
"properties": {
"parts": {
"enum": [
"both",
"contract",
"ui_schemas"
],
"type": "string",
"description": "What to return (default 'both'): 'contract' = state machine/ops/schemas; 'ui_schemas' = default UI only."
},
"service_id": {
"type": "string",
"description": "The service id (e.g. 'cart', 'booking', 'payment'); 'index' (default) lists all."
}
}
}Fetch a Supero build reference. doc='skills' (default, the spec you MUST follow) | 'components' (the real pre-built SDK component/global catalog — read so you don't reinvent UI) | 'rubric' (the rich-app quality checklist — what 'stunning' means) | 'landing' (compact landing-page derivation + quality bar — MANDATORY read for public-facing apps) | 'integrations' (the EXACT services.* wrapper→service_id→args map for email/sms/stripe/ai/etc.) | 'web' / 'transactional' / 'workflows' / 'mobile' / 'services' (deep companion docs) | 'e2e_testing'. Returns the doc + a content version + the SDK floor to pin. Read 'skills' FIRST, then 'components' + a matching build_get_examples before you author UI. Docs are PAGED (~32KB/section): when the header says more:true, fetch the next section with offset=<next_offset> — never re-fetch from 0.
| Argument | Type | Description |
|---|---|---|
| doc | string | Which doc (default 'skills'). |
| offset | integer | Byte offset to start from (for paging large docs; default 0). |
| max_bytes | integer | Max bytes to return per section (default ~32000). |
{
"type": "object",
"properties": {
"doc": {
"enum": [
"skills",
"components",
"rubric",
"landing",
"integrations",
"web",
"transactional",
"workflows",
"mobile",
"services",
"e2e_testing",
"connectors"
],
"type": "string",
"description": "Which doc (default 'skills')."
},
"offset": {
"type": "integer",
"description": "Byte offset to start from (for paging large docs; default 0)."
},
"max_bytes": {
"type": "integer",
"description": "Max bytes to return per section (default ~32000)."
}
}
}PERMANENT deploy: promote a published version to a PERMANENT public URL at <service>.supero.live (managed Cloud Run) — unlike build_deploy(target='cloud_ephemeral'), which is a ~30-min throwaway. If version_uuid/file_id are omitted, the latest published version for the project is used. Returns public_url + poll_url; poll with build_deploy_status until live, then build_smoke_test the public_url. build_teardown removes it. Requires a domain- or project-admin API key + platform cloud-deploy enablement.
| Argument | Type | Description |
|---|---|---|
| file_id | string | Default: the resolved version's web artifact file_id. |
| project_uuid* | string | Project UUID (from build_list_projects or build_create_project). |
| version_uuid | string | Default: latest published version. |
{
"type": "object",
"required": [
"project_uuid"
],
"properties": {
"file_id": {
"type": "string",
"description": "Default: the resolved version's web artifact file_id."
},
"project_uuid": {
"type": "string",
"description": "Project UUID (from build_list_projects or build_create_project)."
},
"version_uuid": {
"type": "string",
"description": "Default: latest published version."
}
}
}Classify this project's schemas: which are connector-backed vs app-authored, and each one's access mode (sync | live-ro | live-rw | warehouse). Use it so you DON'T render create/edit UI for read-only live sources (live-ro/warehouse) or regenerate/overwrite connector-discovered schemas.
| Argument | Type | Description |
|---|---|---|
| project_uuid | string | Defaults to the key's project. |
{
"type": "object",
"properties": {
"project_uuid": {
"type": "string",
"description": "Defaults to the key's project."
}
}
}List the platform's available services/integrations from the LIVE catalog (email, sms, slack, ai, stripe_checkout, google_oauth, push_notification, …) — so the intake's 'which connections/integrations?' question is accurate and you never guess a service id. Returns each service's exact catalog `service_id` (use it verbatim in config.py `services` — e.g. 'stripe_checkout', NOT 'stripe'), category, whether it needs a key, and YOUR connection's service permissions (can_import / can_configure). Descriptive — what EXISTS, never what to use. Pass service_id for one service's config fields.
| Argument | Type | Description |
|---|---|---|
| category | string | Optional filter ('integration' or 'service'). |
| service_id | string | Optional: one service's detail incl. config fields. |
{
"type": "object",
"properties": {
"category": {
"type": "string",
"description": "Optional filter ('integration' or 'service')."
},
"service_id": {
"type": "string",
"description": "Optional: one service's detail incl. config fields."
}
}
}List the external DATA SOURCE types an app can connect to — its own Postgres/MySQL/MSSQL/Oracle/MongoDB, any REST API, or a Snowflake/BigQuery/Redshift/Databricks/ClickHouse/Fabric warehouse — plus the curated public-API catalog. Read this to offer a 'connect your own data' option. Flow: build_connect_data_source → build_discover_source → build_bind_data_source. See build_get_skills(doc='connectors').
No arguments.
{
"type": "object",
"properties": {}
}List projects you can build into (uuid, name, schema_namespace, live_url).
| Argument | Type | Description |
|---|---|---|
| limit | integer | Max results (default 50). |
{
"type": "object",
"properties": {
"limit": {
"type": "integer",
"description": "Max results (default 50)."
}
}
}Fetch recent Cloud Run logs for a project's deployed app — THE tool for diagnosing a failed/stalled cloud deploy or a crashing app (startup-probe timeouts, tracebacks, 'container failed to start on PORT'). Read-only; rate-limited per domain.
| Argument | Type | Description |
|---|---|---|
| lines | integer | Max log lines to return (default 200). |
| since | integer | How many minutes back to fetch (default 60). |
| project_uuid* | string | Project UUID (from build_list_projects or build_create_project). |
{
"type": "object",
"required": [
"project_uuid"
],
"properties": {
"lines": {
"type": "integer",
"description": "Max log lines to return (default 200)."
},
"since": {
"type": "integer",
"description": "How many minutes back to fetch (default 60)."
},
"project_uuid": {
"type": "string",
"description": "Project UUID (from build_list_projects or build_create_project)."
}
}
}PLAN FIRST — turn a one-line app idea into an explicit BUILD CHECKLIST before you author anything, so a thin prompt doesn't silently skip what expert builders add (this is exactly why first-draft apps miss detail pages, tenant pickers, seed data). Deterministic, no LLM: it detects the app's VERTICAL and returns the authentic page structure + terminology for that domain, which entities need a full DETAIL PAGE, the multi-tenant login pattern (picker + tenant=''), seed guidance, and which build_get_examples to copy. Call it right after build_get_skills and BEFORE authoring.
| Argument | Type | Description |
|---|---|---|
| entities | array | Optional: the main entity/noun names (e.g. ['college','course','student']). Sharpens the per-entity detail-page + seed guidance. |
| description* | string | The app idea in a sentence or two (e.g. 'portal for Karnataka polytechnic colleges with admin + student portals'). |
| public_facing | boolean | Optional: true if end-users/the public browse it (vs an internal-only tool). Inferred if omitted. |
| is_multi_tenant | boolean | Optional: true if each customer/org (college/clinic/branch) is a separate tenant. Inferred from the description if omitted. |
{
"type": "object",
"required": [
"description"
],
"properties": {
"entities": {
"type": "array",
"items": {
"type": "string"
},
"description": "Optional: the main entity/noun names (e.g. ['college','course','student']). Sharpens the per-entity detail-page + seed guidance."
},
"description": {
"type": "string",
"description": "The app idea in a sentence or two (e.g. 'portal for Karnataka polytechnic colleges with admin + student portals')."
},
"public_facing": {
"type": "boolean",
"description": "Optional: true if end-users/the public browse it (vs an internal-only tool). Inferred if omitted."
},
"is_multi_tenant": {
"type": "boolean",
"description": "Optional: true if each customer/org (college/clinic/branch) is a separate tenant. Inferred from the description if omitted."
}
}
}Package + upload your authored bundle and record a version under the project. Returns version_uuid + file_id + download_url. Runs build_validate first; force=true overrides soft errors only. Provide files as {relative_path: content}.
| Argument | Type | Description |
|---|---|---|
| files | object | Map of {relative_path: file_content}. |
| force | boolean | Publish despite SOFT validation errors (default false). Validation still runs; a wrong/absent schema namespace, a JavaScript syntax error or schemas the platform refuses always block. |
| app_type | string | Default 'web'. |
| validate | boolean | Validate before publish (default true). |
| files_ref | string | For a LARGE bundle that exceeds the model output-token cap: a file_id from build_stage_bundle (upload the gzip(json {path:content}) blob out-of-band, then pass its file_id here). Preferred over files/files_b64gz when the bundle will not fit inline. |
| files_b64gz | string | Alt to files: base64(gzip(JSON {path:content})). Use if a CDN/WAF blocks raw code in the body. |
| project_uuid* | string | Project UUID (from build_list_projects or build_create_project). |
RECOMMEND which concrete provider integrations this app needs, and WHY — the deterministic Step-2 intelligence the web wizard uses, now over MCP. Pass the app `description` + the platform `service_ids` it will use (e.g. ['cart','order']); returns GROUPED, TIERED suggestions (required/recommended/optional) with the default option flagged — e.g. cart/checkout → a payment gateway (REQUIRED; stripe_checkout default, paypal/razorpay offered), customer-facing apps → transactional email, appointments+reminders → sms. Options are drawn ONLY from the LIVE installed manifests, so it can't suggest a provider you don't have. PRESCRIPTIVE complement to build_list_capabilities (which is descriptive): call this so you don't OMIT a needed integration; use build_list_capabilities for a service's exact id + config fields.
| Argument | Type | Description |
|---|---|---|
| description | string | The app description / intent (drives email/sms/oauth/ai/payment triggers). |
| service_ids | array | Platform service ids the app will use (e.g. ['cart','order','appointment']). Drives most recommendations. |
{
"type": "object",
"properties": {
"description": {
"type": "string",
"description": "The app description / intent (drives email/sms/oauth/ai/payment triggers)."
},
"service_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "Platform service ids the app will use (e.g. ['cart','order','appointment']). Drives most recommendations."
}
}
}DESTRUCTIVE (DOMAIN-admin keys only): completely replace a DEV-mode project's app — wipes its data (retains credentials, API keys, namespace, tenant). Refused if mode='live'. Requires confirm_project_name to match. If you pass files, they are VALIDATED before any wipe (a bad bundle is a no-op) and published after; otherwise wipe-only, then call build_publish.
| Argument | Type | Description |
|---|---|---|
| files | object | Optional new bundle {path: content} to publish after the wipe. |
| force | boolean | Wipe and publish despite SOFT validation errors (default false). Never overrides a wrong/absent schema namespace, a JavaScript syntax error or schemas the platform refuses: those are refused before anything is wiped. |
| app_type | string | Default 'web'. |
| files_ref | string | For a LARGE bundle that exceeds the model output-token cap: a file_id from build_stage_bundle (upload the gzip(json {path:content}) blob out-of-band, then pass its file_id here). Preferred over files/files_b64gz when the bundle will not fit inline. |
| files_b64gz | string | Alt to files: base64(gzip(JSON {path:content})). Use if a CDN/WAF blocks raw code in the body. |
| project_uuid* | string | Project UUID (from build_list_projects or build_create_project). |
Trigger a SYNC RUN on a data connector and return the run id. MCP-created connectors are trigger:manual, so a mode='sync' binding copies NO rows until a run executes — call this after build_bind_data_source (and again whenever the source data changes). Live-read/warehouse bindings don't need runs (they read the source directly).
| Argument | Type | Description |
|---|---|---|
| connector_id* | string | The connector to run (from build_connect_data_source). |
{
"type": "object",
"required": [
"connector_id"
],
"properties": {
"connector_id": {
"type": "string",
"description": "The connector to run (from build_connect_data_source)."
}
}
}Set a project's build mode. 'dev' (default) allows COMPLETE REPLACE (wipe data, keep credentials); 'live' protects it. Switch to dev before replacing, to live when it's in production.
| Argument | Type | Description |
|---|---|---|
| mode* | string | 'dev' permits build_replace_project (which still needs a domain-admin key and confirm_project_name); 'live' makes it refuse, protecting production data. |
| project_uuid* | string | Project UUID (from build_list_projects or build_create_project). |
{
"type": "object",
"required": [
"project_uuid",
"mode"
],
"properties": {
"mode": {
"enum": [
"dev",
"live"
],
"type": "string",
"description": "'dev' permits build_replace_project (which still needs a domain-admin key and confirm_project_name); 'live' makes it refuse, protecting production data."
},
"project_uuid": {
"type": "string",
"description": "Project UUID (from build_list_projects or build_create_project)."
}
}
}VERIFY a DEPLOYED app actually works (not just 'running'). HTTP-checks the live URL: root loads with a title, app.js is your bundle (not a stub) and dismisses the boot splash, config.js namespace matches the project; optionally logs in and reads an entity to confirm data + no namespace ambiguity. Pass url= (from build_deploy_status) or poll_url=. THE post-deploy gate — run it after every deploy.
| Argument | Type | Description |
|---|---|---|
| url | string | The deployed app URL (from build_deploy_status). |
| string | Optional — a user to log in and verify data reads. | |
| entity | string | Optional bare schema slug (e.g. 'participant') to read for the authed data check. |
| tenant | string | Optional tenant for the login. Default '' so the server resolves the user's OWN tenant (required for a multi-tenant app whose test user lives in a named tenant). |
| password | string | Optional — password for that user. |
| poll_url | string | Alt to url: the build_deploy poll_url; the URL is resolved from it. |
| project_uuid* | string | The deployed project (for namespace + live_url). |
| expected_app_js_sha1 | string |
PUB-1a: get the out-of-band UPLOAD endpoint for a LARGE app bundle that won't fit inline (the model's max OUTPUT tokens cap `files`/`files_b64gz`, so big apps otherwise have to be truncated/minified). Upload a gzip(json {path:content}) blob to the returned URL with your OWN key, then pass the returned file_id as `files_ref` to build_validate / build_publish / build_doctor. Bundle size then no longer depends on any token cap.
No arguments.
{
"type": "object",
"properties": {}
}Tear down a project's live deployment — BOTH the permanent (build_go_live) app and the ephemeral preview — DELETEing the managed Cloud Run services and freeing their URLs. Idempotent: a project with nothing deployed returns stopped=true. ONLY manages Supero-hosted apps — a project deployed to your own AWS/GCP is refused, not silently reported stopped. Check `stopped`: false means the teardown was INCOMPLETE and the app may still be serving (and billing) — re-run it, do not report success. Requires a domain- or project-admin API key.
| Argument | Type | Description |
|---|---|---|
| project_uuid* | string | Project UUID (from build_list_projects or build_create_project). |
{
"type": "object",
"required": [
"project_uuid"
],
"properties": {
"project_uuid": {
"type": "string",
"description": "Project UUID (from build_list_projects or build_create_project)."
}
}
}Update a project's metadata (display_name, description, show_public, live_url).
| Argument | Type | Description |
|---|---|---|
| patch* | object | Fields to update. |
| project_uuid* | string | Project UUID (from build_list_projects or build_create_project). |
{
"type": "object",
"required": [
"project_uuid",
"patch"
],
"properties": {
"patch": {
"type": "object",
"description": "Fields to update."
},
"project_uuid": {
"type": "string",
"description": "Project UUID (from build_list_projects or build_create_project)."
}
}
}Validate a locally-authored bundle against the live platform BEFORE publishing. AST-only (your code is never executed). Checks manifest, syntax, import-safety, config exports, schema validity, and namespace==project schema_namespace.
| Argument | Type | Description |
|---|---|---|
| files | object | Map of {relative_path: file_content} for the bundle. |
| files_ref | string | For a LARGE bundle that exceeds the model output-token cap: a file_id from build_stage_bundle (upload the gzip(json {path:content}) blob out-of-band, then pass its file_id here). Preferred over files/files_b64gz when the bundle will not fit inline. |
| files_b64gz | string | Alt to files: base64(gzip(JSON {path:content})). Use if a CDN/WAF blocks raw code in the body. |
| project_uuid | string | Target project (for namespace/schema checks). |
{
"type": "object",
"required": [],
"properties": {
"files": {
"type": "object",
"description": "Map of {relative_path: file_content} for the bundle."
},
"files_ref": {
"type": "string",
"description": "For a LARGE bundle that exceeds the model output-token cap: a file_id from build_stage_bundle (upload the gzip(json {path:content}) blob out-of-band, then pass its file_id here). Preferred over files/files_b64gz when the bundle will not fit inline."
},
"files_b64gz": {
"type": "string",
"description": "Alt to files: base64(gzip(JSON {path:content})). Use if a CDN/WAF blocks raw code in the body."
},
"project_uuid": {
"type": "string",
"description": "Target project (for namespace/schema checks)."
}
}
}Resolve your API key's scope: role (domain_admin/project_admin), domain, whether you can create projects, and your plan. Call this to decide the flow.
No arguments.
{
"type": "object",
"properties": {}
}Cancel a running connector execution.
| Argument | Type | Description |
|---|---|---|
| connector_id* | string | UUID of the connector. |
| execution_id* | string | UUID of the execution to cancel. |
{
"type": "object",
"required": [
"connector_id",
"execution_id"
],
"properties": {
"connector_id": {
"type": "string",
"description": "UUID of the connector."
},
"execution_id": {
"type": "string",
"description": "UUID of the execution to cancel."
}
}
}Disable a connector.
| Argument | Type | Description |
|---|---|---|
| connector_id* | string | UUID of the connector. |
{
"type": "object",
"required": [
"connector_id"
],
"properties": {
"connector_id": {
"type": "string",
"description": "UUID of the connector."
}
}
}Trigger schema/metadata discovery for a connector.
| Argument | Type | Description |
|---|---|---|
| params | object | Optional discovery parameters. |
| connector_id* | string | UUID of the connector. |
{
"type": "object",
"required": [
"connector_id"
],
"properties": {
"params": {
"type": "object",
"description": "Optional discovery parameters."
},
"connector_id": {
"type": "string",
"description": "UUID of the connector."
}
}
}Get discovery results.
| Argument | Type | Description |
|---|---|---|
| connector_id* | string | UUID of the connector. |
| execution_id* | string | UUID of the discovery execution. |
{
"type": "object",
"required": [
"connector_id",
"execution_id"
],
"properties": {
"connector_id": {
"type": "string",
"description": "UUID of the connector."
},
"execution_id": {
"type": "string",
"description": "UUID of the discovery execution."
}
}
}Get discovery execution status.
| Argument | Type | Description |
|---|---|---|
| connector_id* | string | UUID of the connector. |
| execution_id* | string | UUID of the discovery execution. |
{
"type": "object",
"required": [
"connector_id",
"execution_id"
],
"properties": {
"connector_id": {
"type": "string",
"description": "UUID of the connector."
},
"execution_id": {
"type": "string",
"description": "UUID of the discovery execution."
}
}
}Enable a connector for scheduling.
| Argument | Type | Description |
|---|---|---|
| connector_id* | string | UUID of the connector. |
{
"type": "object",
"required": [
"connector_id"
],
"properties": {
"connector_id": {
"type": "string",
"description": "UUID of the connector."
}
}
}List available connector plugins.
No arguments.
{
"type": "object",
"properties": {}
}Trigger a manual connector sync execution.
| Argument | Type | Description |
|---|---|---|
| params | object | Optional execution parameters. |
| connector_id* | string | UUID of the connector. |
{
"type": "object",
"required": [
"connector_id"
],
"properties": {
"params": {
"type": "object",
"description": "Optional execution parameters."
},
"connector_id": {
"type": "string",
"description": "UUID of the connector."
}
}
}Get connector status and recent executions.
| Argument | Type | Description |
|---|---|---|
| connector_id* | string | UUID of the connector. |
{
"type": "object",
"required": [
"connector_id"
],
"properties": {
"connector_id": {
"type": "string",
"description": "UUID of the connector."
}
}
}Test an existing connector's connectivity.
| Argument | Type | Description |
|---|---|---|
| connector_id* | string | UUID of the connector. |
{
"type": "object",
"required": [
"connector_id"
],
"properties": {
"connector_id": {
"type": "string",
"description": "UUID of the connector."
}
}
}Test a connector configuration.
| Argument | Type | Description |
|---|---|---|
| config* | object | Connector config to test. |
{
"type": "object",
"required": [
"config"
],
"properties": {
"config": {
"type": "object",
"description": "Connector config to test."
}
}
}Create a new object in the current domain. Use schema_list to see available types and their fields.
| Argument | Type | Description |
|---|---|---|
| data | object | Object fields as key-value pairs |
| name* | string | Object name (required for most types) |
| tenant | string | Optional tenant name to create the object under (multi-tenant apps: seed a specific named tenant's data). Omit for single-tenant apps — the session/API-key tenant is used. |
| object_type* | string | The object type to create (e.g. 'customer', 'appointment', 'project') |
| parent_type | string | Parent type if applicable (e.g. 'project' for tenant, 'domain' for project) |
| parent_fq_name | array | Parent FQ name path (e.g. ['cine-corp', 'car-service']) |
{
"type": "object",
"required": [
"object_type",
"name"
],
"properties": {
"data": {
"type": "object",
"description": "Object fields as key-value pairs"
},
"name": {
"type": "string",
"description": "Object name (required for most types)"
},
"tenant": {
"type": "string",
"description": "Optional tenant name to create the object under (multi-tenant apps: seed a specific named tenant's data). Omit for single-tenant apps — the session/API-key tenant is used."
},
"object_type": {
"type": "string",
"description": "The object type to create (e.g. 'customer', 'appointment', 'project')"
},
"parent_type": {
"type": "string",
"description": "Parent type if applicable (e.g. 'project' for tenant, 'domain' for project)"
},
"parent_fq_name": {
"type": "array",
"items": {
"type": "string"
},
"description": "Parent FQ name path (e.g. ['cine-corp', 'car-service'])"
}
}
}Delete an object from the current domain.
| Argument | Type | Description |
|---|---|---|
| uuid* | string | Object UUID to delete |
| tenant | string | Optional tenant name context for this delete (multi-tenant apps). Omit for single-tenant apps — the session/API-key tenant is used. Deletes address the record by UUID. |
| object_type* | string | The object type |
{
"type": "object",
"required": [
"object_type",
"uuid"
],
"properties": {
"uuid": {
"type": "string",
"description": "Object UUID to delete"
},
"tenant": {
"type": "string",
"description": "Optional tenant name context for this delete (multi-tenant apps). Omit for single-tenant apps — the session/API-key tenant is used. Deletes address the record by UUID."
},
"object_type": {
"type": "string",
"description": "The object type"
}
}
}Get a specific object by UUID from the current domain.
| Argument | Type | Description |
|---|---|---|
| uuid* | string | Object UUID |
| object_type* | string | The object type (e.g. 'customer', 'project', 'tenant') |
{
"type": "object",
"required": [
"object_type",
"uuid"
],
"properties": {
"uuid": {
"type": "string",
"description": "Object UUID"
},
"object_type": {
"type": "string",
"description": "The object type (e.g. 'customer', 'project', 'tenant')"
}
}
}Search/list objects of any type in the current domain. Use schema_list first to discover available object types. System types: project, tenant, user_account, api_key, connector, audit_log, schema_registry, client_sdk, connector_execution, connector_plugin. Domain types vary per domain (e.g. customer, invoice, appointment, vehicle).
| Argument | Type | Description |
|---|---|---|
| sort | any | Optional sort: a field name ('amount', or '-amount' for descending), {"field": "amount", "order": "desc"}, or a list of those. |
| limit | integer | Max results (default: 100, max 1000) |
| filter | object | Optional boolean filter tree for and/or/not logic, e.g. {"op": "or", "conditions": [{"status": "open"}, {"amount": {"gt": 500}}]}. Use `filters` for simple AND-ed conditions. |
| offset | integer | Skip N results for pagination |
| tenant | string | Optional tenant name to scope the search to (multi-tenant apps: verify a specific named tenant's data). Omit for single-tenant apps — the session/API-key tenant is used. |
| filters | object | Filter criteria keyed by field. A plain value is equality (e.g. {"status": "active"}); an object of operators compares (e.g. {"amount": {"gte": 10, "lt": 100}}). Operators: eq, ne, gt, gte, lt, lte, in, not_in, between, contains, starts_with, ends_with, regex, exists. |
Update an existing object in the current domain.
| Argument | Type | Description |
|---|---|---|
| data* | object | Fields to update |
| uuid* | string | Object UUID to update |
| tenant | string | Optional tenant name context for this update (multi-tenant apps). Omit for single-tenant apps — the session/API-key tenant is used. Updates address the record by UUID. |
| object_type* | string | The object type |
{
"type": "object",
"required": [
"object_type",
"uuid",
"data"
],
"properties": {
"data": {
"type": "object",
"description": "Fields to update"
},
"uuid": {
"type": "string",
"description": "Object UUID to update"
},
"tenant": {
"type": "string",
"description": "Optional tenant name context for this update (multi-tenant apps). Omit for single-tenant apps — the session/API-key tenant is used. Updates address the record by UUID."
},
"object_type": {
"type": "string",
"description": "The object type"
}
}
}Link schemas to a project. Accepts schema UUIDs or names.
| Argument | Type | Description |
|---|---|---|
| project_uuid* | string | UUID of the project to link schemas to. |
| schema_names | array | List of schema names to link (resolved to UUIDs). Use 'namespace:name' when a name exists in several namespaces. |
| schema_uuids | array | List of schema registry UUIDs to link. |
{
"type": "object",
"required": [
"project_uuid"
],
"properties": {
"project_uuid": {
"type": "string",
"description": "UUID of the project to link schemas to."
},
"schema_names": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of schema names to link (resolved to UUIDs). Use 'namespace:name' when a name exists in several namespaces."
},
"schema_uuids": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of schema registry UUIDs to link."
}
}
}Check if the current user has a specific permission.
| Argument | Type | Description |
|---|---|---|
| permission* | string | Permission to check (e.g. 'schema:manage', 'data:write'). |
{
"type": "object",
"required": [
"permission"
],
"properties": {
"permission": {
"type": "string",
"description": "Permission to check (e.g. 'schema:manage', 'data:write')."
}
}
}Get current user's role, permissions, and scope.
No arguments.
{
"type": "object",
"properties": {}
}Delete a schema from the domain. Use with caution.
| Argument | Type | Description |
|---|---|---|
| schema_uuid* | string | UUID of the schema to delete. |
| force_delete | boolean | Force delete even with dependencies (default: false). |
{
"type": "object",
"required": [
"schema_uuid"
],
"properties": {
"schema_uuid": {
"type": "string",
"description": "UUID of the schema to delete."
},
"force_delete": {
"type": "boolean",
"description": "Force delete even with dependencies (default: false)."
}
}
}Get full details of a specific schema by UUID. Returns the complete schema definition including all attributes and metadata.
| Argument | Type | Description |
|---|---|---|
| schema_uuid* | string | UUID of the schema to retrieve. |
| include_content | boolean | Include full schema content (default: true). |
{
"type": "object",
"required": [
"schema_uuid"
],
"properties": {
"schema_uuid": {
"type": "string",
"description": "UUID of the schema to retrieve."
},
"include_content": {
"type": "boolean",
"description": "Include full schema content (default: true)."
}
}
}List all existing schemas in the current domain.
No arguments.
{
"type": "object",
"properties": {}
}List schemas linked to the current project.
| Argument | Type | Description |
|---|---|---|
| project_uuid | string | Project to list schemas for. Optional; defaults to the key's project when resolvable (pass the project_uuid from build_whoami/build_list_projects under an API key). |
| include_content | boolean | Include full schema content (default: true). |
{
"type": "object",
"properties": {
"project_uuid": {
"type": "string",
"description": "Project to list schemas for. Optional; defaults to the key's project when resolvable (pass the project_uuid from build_whoami/build_list_projects under an API key)."
},
"include_content": {
"type": "boolean",
"description": "Include full schema content (default: true)."
}
}
}Save/upload schemas into a project. Schemas are validated before saving and linked to the project. Returns the saved schemas with their UUIDs; skipped schemas carry the platform's reason. IMPORTANT: Pass FLAT schema objects directly — do NOT wrap in schema_content. The tool handles schema_type detection and wrapping automatically. Required fields: name, namespace, parent_type, attributes. Set namespace to your app's namespace (e.g. 'shop'); the schema is stored as namespace:name. Mark required attributes with "mandatory": true. Supported attribute types: 'string' for text, 'float' for decimal numbers (NOT 'number'), 'integer' for whole numbers, 'boolean' for true/false. project_uuid defaults to your key's project; a project-scoped key can only save into its own project. A schema skipped for compatibility warnings is applied with force_upload=true. Example: { "schemas": [{ "name": "product", "namespace": "shop", "description": "Product catalog entry", "parent_type": "tenant", "attributes": [ {"name": "title", "type": "string", "mandatory": true}, {"name": "price", "type": "float"}, {"name": "stock", "type": "integer"} ] }] }
| Argument | Type | Description |
|---|---|---|
| schemas* | array | Array of schema definitions to save. |
| force_upload | boolean | Apply changes that only have compatibility WARNINGS (default: false). Breaking changes are still refused. |
| project_uuid | string | Project to save into (defaults to your key's project; required for a domain-admin key). |
| skip_existing | boolean | Skip schemas that already exist (default: true). |
Update an existing schema definition.
| Argument | Type | Description |
|---|---|---|
| new_version | string | Optional new version string. |
| schema_uuid* | string | UUID of the schema to update. |
| schema_content* | object | New schema content (full schema definition). |
| check_compatibility | boolean | Check compatibility with existing data (default: true). |
{
"type": "object",
"required": [
"schema_uuid",
"schema_content"
],
"properties": {
"new_version": {
"type": "string",
"description": "Optional new version string."
},
"schema_uuid": {
"type": "string",
"description": "UUID of the schema to update."
},
"schema_content": {
"type": "object",
"description": "New schema content (full schema definition)."
},
"check_compatibility": {
"type": "boolean",
"description": "Check compatibility with existing data (default: true)."
}
}
}Validate schemas before saving. Checks for conflicts with existing schemas, circular dependencies, reserved names, and parent_type correctness. Always validate before saving!
| Argument | Type | Description |
|---|---|---|
| schemas* | array | Array of schema definitions to validate. |
{
"type": "object",
"required": [
"schemas"
],
"properties": {
"schemas": {
"type": "array",
"items": {
"type": "object"
},
"description": "Array of schema definitions to validate."
}
}
}Get download URL for an SDK.
| Argument | Type | Description |
|---|---|---|
| artifact | string | Artifact type (default: 'wheel'). |
| sdk_uuid* | string | UUID of the SDK. |
{
"type": "object",
"required": [
"sdk_uuid"
],
"properties": {
"artifact": {
"enum": [
"wheel",
"source",
"docs"
],
"type": "string",
"description": "Artifact type (default: 'wheel')."
},
"sdk_uuid": {
"type": "string",
"description": "UUID of the SDK."
}
}
}Generate client SDKs for the domain's schemas.
| Argument | Type | Description |
|---|---|---|
| languages | array | Languages to generate (default: ['python', 'javascript']). |
| include_docs | boolean | Include docs (default: true). |
| force_rebuild | boolean | Force rebuild (default: false). |
{
"type": "object",
"properties": {
"languages": {
"type": "array",
"items": {
"enum": [
"python",
"javascript",
"java",
"go",
"cpp"
],
"type": "string"
},
"description": "Languages to generate (default: ['python', 'javascript'])."
},
"include_docs": {
"type": "boolean",
"description": "Include docs (default: true)."
},
"force_rebuild": {
"type": "boolean",
"description": "Force rebuild (default: false)."
}
}
}List available SDKs for the current domain.
| Argument | Type | Description |
|---|---|---|
| limit | integer | Max results (default: 50). |
| language | string | Filter by language. |
{
"type": "object",
"properties": {
"limit": {
"type": "integer",
"description": "Max results (default: 50)."
},
"language": {
"type": "string",
"description": "Filter by language."
}
}
}Check SDK generation request status.
| Argument | Type | Description |
|---|---|---|
| request_id* | string | Request ID from sdk_generate. |
{
"type": "object",
"required": [
"request_id"
],
"properties": {
"request_id": {
"type": "string",
"description": "Request ID from sdk_generate."
}
}
}| string |
| api kind: API base URL. |
| database | string | database/warehouse: database name. |
| endpoint | string | api kind: endpoint path. |
| password | string | DB password — sent to the platform, never echoed. |
| ssl_mode | string | database kind: TLS mode, one of disable|allow|prefer|require|verify-ca|verify-full (or the MySQL spellings disabled|preferred|required|verify_ca|verify_identity); other values are rejected. Default 'require'. Used by PostgreSQL/MySQL/MSSQL/Fabric/MongoDB; Oracle and the HTTP warehouses (Snowflake/Databricks/ClickHouse/BigQuery/Redshift) ignore it. |
| username | string | database/warehouse: login user (prefer a read-only one). |
| test_first | boolean | Probe connectivity before creating (default true). |
| project_uuid | string | Project the connector belongs to (from build_list_projects); your key must be allowed to build into it. API-key callers pass it to scope the connector to that project. |
| schema_namespace | string | Namespace for schemas from this source. |
{
"type": "object",
"required": [
"name",
"kind"
],
"properties": {
"auth": {
"type": "object",
"description": "api kind: {type: none|api_key|bearer|basic|oauth2, ...}."
},
"host": {
"type": "string",
"description": "Server hostname (database kinds, Fabric, ClickHouse, Snowflake, Databricks). BigQuery/Redshift take their connection settings in `config`."
},
"kind": {
"enum": [
"database",
"api",
"warehouse"
],
"type": "string",
"description": "Source kind."
},
"name": {
"type": "string",
"description": "Connector name (unique within the project)."
},
"port": {
"type": "integer",
"description": "Server port; omit for the dialect default (5432 PostgreSQL, 3306 MySQL, 1433 MSSQL/Fabric, 1521 Oracle, 27017 MongoDB)."
},
"config": {
"type": "object",
"description": "Extra source config (e.g. warehouse account)."
},
"db_type": {
"type": "string",
"description": "database/warehouse: postgresql|mysql|mssql|oracle|mongodb|snowflake|bigquery|redshift|databricks|clickhouse|fabric."
},
"base_url": {
"type": "string",
"description": "api kind: API base URL."
},
"database": {
"type": "string",
"description": "database/warehouse: database name."
},
"endpoint": {
"type": "string",
"description": "api kind: endpoint path."
},
"password": {
"type": "string",
"description": "DB password — sent to the platform, never echoed."
},
"ssl_mode": {
"type": "string",
"description": "database kind: TLS mode, one of disable|allow|prefer|require|verify-ca|verify-full (or the MySQL spellings disabled|preferred|required|verify_ca|verify_identity); other values are rejected. Default 'require'. Used by PostgreSQL/MySQL/MSSQL/Fabric/MongoDB; Oracle and the HTTP warehouses (Snowflake/Databricks/ClickHouse/BigQuery/Redshift) ignore it."
},
"username": {
"type": "string",
"description": "database/warehouse: login user (prefer a read-only one)."
},
"test_first": {
"type": "boolean",
"description": "Probe connectivity before creating (default true)."
},
"project_uuid": {
"type": "string",
"description": "Project the connector belongs to (from build_list_projects); your key must be allowed to build into it. API-key callers pass it to scope the connector to that project."
},
"schema_namespace": {
"type": "string",
"description": "Namespace for schemas from this source."
}
}
}{
"type": "object",
"required": [
"project_uuid"
],
"properties": {
"files": {
"type": "object",
"description": "Map of {relative_path: file_content}."
},
"force": {
"type": "boolean",
"description": "Publish despite SOFT validation errors (default false). Validation still runs; a wrong/absent schema namespace, a JavaScript syntax error or schemas the platform refuses always block."
},
"app_type": {
"enum": [
"web",
"all"
],
"type": "string",
"description": "Default 'web'."
},
"validate": {
"type": "boolean",
"description": "Validate before publish (default true)."
},
"files_ref": {
"type": "string",
"description": "For a LARGE bundle that exceeds the model output-token cap: a file_id from build_stage_bundle (upload the gzip(json {path:content}) blob out-of-band, then pass its file_id here). Preferred over files/files_b64gz when the bundle will not fit inline."
},
"files_b64gz": {
"type": "string",
"description": "Alt to files: base64(gzip(JSON {path:content})). Use if a CDN/WAF blocks raw code in the body."
},
"project_uuid": {
"type": "string",
"description": "Project UUID (from build_list_projects or build_create_project)."
}
}
}| confirm_project_name* | string | Must equal the project's name — a safety confirmation. |
{
"type": "object",
"required": [
"project_uuid",
"confirm_project_name"
],
"properties": {
"files": {
"type": "object",
"description": "Optional new bundle {path: content} to publish after the wipe."
},
"force": {
"type": "boolean",
"description": "Wipe and publish despite SOFT validation errors (default false). Never overrides a wrong/absent schema namespace, a JavaScript syntax error or schemas the platform refuses: those are refused before anything is wiped."
},
"app_type": {
"enum": [
"web",
"all"
],
"type": "string",
"description": "Default 'web'."
},
"files_ref": {
"type": "string",
"description": "For a LARGE bundle that exceeds the model output-token cap: a file_id from build_stage_bundle (upload the gzip(json {path:content}) blob out-of-band, then pass its file_id here). Preferred over files/files_b64gz when the bundle will not fit inline."
},
"files_b64gz": {
"type": "string",
"description": "Alt to files: base64(gzip(JSON {path:content})). Use if a CDN/WAF blocks raw code in the body."
},
"project_uuid": {
"type": "string",
"description": "Project UUID (from build_list_projects or build_create_project)."
},
"confirm_project_name": {
"type": "string",
"description": "Must equal the project's name — a safety confirmation."
}
}
}| Optional — the first 12 lowercase hex chars of `sha1sum ui/app.js` (sha1 of your local bundle FILE). If given, smoke_test reports whether the DEPLOYED app.js matches, so you can confirm the deploy actually rolled (vs a stuck roll / stale cache serving the old bundle). Case-insensitive; a malformed value is reported as a warning, never a false mismatch. |
{
"type": "object",
"required": [
"project_uuid"
],
"properties": {
"url": {
"type": "string",
"description": "The deployed app URL (from build_deploy_status)."
},
"email": {
"type": "string",
"description": "Optional — a user to log in and verify data reads."
},
"entity": {
"type": "string",
"description": "Optional bare schema slug (e.g. 'participant') to read for the authed data check."
},
"tenant": {
"type": "string",
"description": "Optional tenant for the login. Default '' so the server resolves the user's OWN tenant (required for a multi-tenant app whose test user lives in a named tenant)."
},
"password": {
"type": "string",
"description": "Optional — password for that user."
},
"poll_url": {
"type": "string",
"description": "Alt to url: the build_deploy poll_url; the URL is resolved from it."
},
"project_uuid": {
"type": "string",
"description": "The deployed project (for namespace + live_url)."
},
"expected_app_js_sha1": {
"type": "string",
"description": "Optional — the first 12 lowercase hex chars of `sha1sum ui/app.js` (sha1 of your local bundle FILE). If given, smoke_test reports whether the DEPLOYED app.js matches, so you can confirm the deploy actually rolled (vs a stuck roll / stale cache serving the old bundle). Case-insensitive; a malformed value is reported as a warning, never a false mismatch."
}
}
}| object_type* | string | The object type to search (e.g. 'customer', 'project', 'tenant', 'connector') |
{
"type": "object",
"required": [
"object_type"
],
"properties": {
"sort": {
"anyOf": [
{
"type": "string"
},
{
"type": "object"
},
{
"type": "array",
"items": {
"type": "object"
}
}
],
"description": "Optional sort: a field name ('amount', or '-amount' for descending), {\"field\": \"amount\", \"order\": \"desc\"}, or a list of those."
},
"limit": {
"type": "integer",
"description": "Max results (default: 100, max 1000)"
},
"filter": {
"type": "object",
"description": "Optional boolean filter tree for and/or/not logic, e.g. {\"op\": \"or\", \"conditions\": [{\"status\": \"open\"}, {\"amount\": {\"gt\": 500}}]}. Use `filters` for simple AND-ed conditions."
},
"offset": {
"type": "integer",
"description": "Skip N results for pagination"
},
"tenant": {
"type": "string",
"description": "Optional tenant name to scope the search to (multi-tenant apps: verify a specific named tenant's data). Omit for single-tenant apps — the session/API-key tenant is used."
},
"filters": {
"type": "object",
"description": "Filter criteria keyed by field. A plain value is equality (e.g. {\"status\": \"active\"}); an object of operators compares (e.g. {\"amount\": {\"gte\": 10, \"lt\": 100}}). Operators: eq, ne, gt, gte, lt, lte, in, not_in, between, contains, starts_with, ends_with, regex, exists."
},
"object_type": {
"type": "string",
"description": "The object type to search (e.g. 'customer', 'project', 'tenant', 'connector')"
}
}
}{
"type": "object",
"required": [
"schemas"
],
"properties": {
"schemas": {
"type": "array",
"items": {
"type": "object"
},
"description": "Array of schema definitions to save."
},
"force_upload": {
"type": "boolean",
"description": "Apply changes that only have compatibility WARNINGS (default: false). Breaking changes are still refused."
},
"project_uuid": {
"type": "string",
"description": "Project to save into (defaults to your key's project; required for a domain-admin key)."
},
"skip_existing": {
"type": "boolean",
"description": "Skip schemas that already exist (default: true)."
}
}
}