Sign in

Get MCP status

<Info>This API is in beta. Endpoints, fields, and behavior may still change, so avoid depending on it in production.</Info>

Returns the app's live MCP server. That covers whether AI clients can connect to it now, its endpoint, how clients authenticate, and the tools it serves.

This reports what the last publish put live, not the config you're editing. Read that with Get MCP config. A server is only active while the app is published, and a workspace rule can turn it off without a publish, which workspace_policy tells you.

This is limited to 120 requests a minute for each app. Some workspaces have a different limit.

<Note>This endpoint accepts a personal API key belonging to a user with access to the app. A read-only key is refused, and workspace API keys are not accepted.</Note>

get/api/apps/platform/{app_id}/mcp-status

Path parameters

app_idstring required

ID of the app.

ID of the app.

Response

The app's live MCP server.

activeboolean

Whether AI clients can use the server right now. It's false until the app is published, while it's unpublished or blocked, when the workspace has turned MCP off or requires oauth from a none server, and when a none server's app requires visitors to log in.

publishedboolean

Whether a publish has put an MCP server live for the app.

endpointstring nullable

URL AI clients connect to, or null when the app has no address yet.

auth'none' | 'oauth' nullable

How clients authenticate with the live server, or null when none is published. Either "oauth", where clients sign in, or "none", where anyone can call the public tools.

effective_public_settingsstring nullable

Who can open the app after its next publish, once workspace SSO rules apply. A none server only works while this is public_without_login.

workspace_policystring

The workspace's rule for app MCP servers. Either "allow", "oauth_only", which stops none servers, or "disabled", which stops every server in the workspace.

Example response

{
  "active": true,
  "published": true,
  "endpoint": "https://my-crm-3c45a1f2.base44.app/api/mcp",
  "auth": "oauth",
  "tools": [
    {
      "name": "query_task",
      "title": "Query tasks",
      "description": "Find Task records by ID or filter.",
      "kind": "entity",
      "handler": "sendInvoice",
      "read_only_hint": true
    }
  ],
  "effective_public_settings": "public_with_login",
  "workspace_policy": "allow"
}

Changes

Changed in 1 of the 33 revisions of this API.1