intent-runtime

    Installation

    Applications require Node.js ≥20, npm, and ESM. Both JavaScript and TypeScript are supported. Use .js in a project with "type": "module", or .mjs for a standalone ESM file. TypeScript uses your existing ESM compilation process; the package includes type declarations. The website's build tools are not required.

    Choose where to install

    This documentation describes Intent Runtime V2.

    Your goalInstall intoNext step
    Call it from Node.jsYour application projectQuick start
    Use the current Codex modelGlobal commandsConfigure, register, reload, and recognize
    Add tools to an MCP serverThe existing server projectComplete SDK example
    Run a standalone MCP serverGlobal commands or a service projectChoose stdio or HTTP

    Install into a Node.js project

    Run in your application directory:

    npm install @devcodex/intent-runtime

    npm automatically installs the required dependencies, including schema-dsl. You do not need a separate schema-dsl installation. Use the npm supplied with Node.js 20 or later.

    Check the dependency tree and load the public export:

    npm ls @devcodex/intent-runtime schema-dsl
node --input-type=module -e "import {Intent} from '@devcodex/intent-runtime'; console.log(typeof Intent)"

    The last command should print function. It checks module loading without calling a model. Continue with the JavaScript or TypeScript quick start.

    Global commands and Codex registration

    To connect Codex or start a standalone MCP service:

    npm install -g @devcodex/intent-runtime
intent-runtime --version
intent-runtime-mcp --version

    Global installation does not change client configuration. Follow Connect Codex to save a configuration and run setup explicitly. Host mode uses the current model and needs no additional model API key. Standalone stdio does not require Codex registration.

    Standalone MCP startup and Codex diagnostics use the optional MCP SDK dependencies, which a normal installation includes. Installing with --omit=optional removes that startup capability. Native/API and the SDK-independent adapter have separate coverage; see Compatibility.

    CLI configuration accepts a trusted absolute .js or .mjs path. For .js, configure the project as ESM. Compile TypeScript configuration to ESM .js before passing it to the CLI; Node 20 does not provide general native TypeScript execution.

    Global installation does not make global packages resolvable from every configuration file. A configuration importing a Builder or API adapter must live in a project with those local dependencies. Copy the complete configuration from the corresponding integration guide.

    Update

    Run npm install @devcodex/intent-runtime in the application, or npm install -g @devcodex/intent-runtime for global commands. See the changelog for changes and Codex maintenance for checks, repair, cleanup, flags, and exit codes. The component does not automatically download or overwrite your business configuration.