intent-runtime

    Choose an integration

    Choose the task you are doing, then follow its model and configuration path. Intent Runtime structures supplied requests; your application continues to own order queries, code changes, and business tools.

    How you use itStart hereModel source and prerequisites
    Call it from Node.jsQuick startExplicit model API or custom executor
    Reuse the current Codex modelConnect CodexCurrent client generates candidates; no additional API key
    Run standalone MCPstdio / HTTP servicehost uses the client model; executor uses a configured server-side API
    Extend existing MCP toolsComplete integrationPreserve the existing connection/tools; choose host or executor
    Use your own gatewayProtocols and gatewaysConfigure compatible Responses/Chat Completions; adapt other protocols
    PathAdditional model key?Connection and state ownership
    Node / executorRequired when using the configured APIApplication owns calls, history, and business state
    Codex / hostNo additional keyCodex provides the model; Runtime manages this handoff
    Existing MCP serverDepends on the selected modeOriginal SDK owns transport; one session per logical client

    Prepare your integration

    TaskWhere to configureHow to startFirst success
    Node.js applicationJS/TS in the application project; your credential sourceRun the application fileparse returns IntentResult with goals and constraints
    Current Codex modelTrusted accessible .js/.mjs; absolute setup pathReload the client or open a new CLI sessionThree host tools visible and accept returns the final result
    Existing MCP serverExisting service code and local dependenciesOriginal SDK startupBoth original and added tools work
    Standalone MCPTrusted .js/.mjs; executor also needs model credentialsstdio by default; add HTTP startup options for HTTPClient can list and call the selected mode's tools

    Global installation does not change local ESM dependency resolution. A configuration importing packages belongs in a project with those dependencies. HTTP can run standalone or in an existing server. Follow the corresponding guide without reading all types first.

    Complete installation, then your chosen path. Native, standalone MCP, and embedded MCP share the same core and successful IntentResult.

    Host and executor modes

    • host: prepare returns material; the current client model generates a candidate; accept validates and assembles the result. The server does not silently call a second model.
    • executor: Native parse or MCP intent_parse calls the configured executor. The caller supplies a working model and credentials.

    Registering tools exposes capabilities; it does not automatically intercept every chat message. See Compatibility.