Reference

Use reference pages when you need exact surface behavior. Use guides when you need workflow judgment.

Design-time reference

PageUse it for
Design MCPApp-scoped design tools, read-only and full endpoints, OAuth scopes, and client setup context.
MCP ReferenceCompare Design MCP, Runtime MCP, and optional notebook-style agent tools.
AuthenticationBearer tokens, OAuth scopes, actors, and webhook auth.

Runtime reference

PageUse it for
Runtime APIGenerated REST commands, projections, batch commands, event import, rebuild, and OpenAPI.
GraphQL APIGenerated GraphQL command mutations and projection queries.
WebhooksInbound external event handling.
SubscriptionsOutbound event delivery by poll or SSE.
Projection QueriesFilters, sorting, pagination, and output shaping.

Modeling reference

PageUse it for
Field TypesCommon command, event, and projection field types.
Expression LanguageGuard, mapping, and policy expressions.
PermissionsRoles, attributes, principals, command execution, and projection reads.
AdaptersExternal service calls from controlled policy workflows.
SandboxesCustom code execution boundaries.

Generated API reference

The generated Runtime API block in this docs site is a template. For a real app, the canonical contract is:

/api/rest/<tenant-id>/<app-id>/openapi

Always inspect the generated contract for the target app and environment before integrating.