安装与版本

在应用中使用需要 Node.js ≥20、npm 和 ESM,支持 JavaScript 与 TypeScript。JavaScript 项目在 package.json 设置 "type": "module" 后使用 .js;无需项目配置的独立文件可用 .mjs。TypeScript 沿用现有 ESM 编译流程,包自带类型声明;不需要安装文档站的构建工具。

选择安装方式

本文档适用于 Intent Runtime V2。按使用场景选择安装位置:

你的目标安装位置安装后的下一步
在 Node.js 应用里调用应用项目快速开始,先识别目标和约束
在 Codex 中使用当前模型全局命令保存配置、登记、重载并识别
给已有 MCP 添加工具现有服务项目完整 SDK Server 示例
启动独立 MCP 服务全局命令或服务项目选择 stdio 或 HTTP

安装到 Node.js 项目

在应用目录执行:

npm install @devcodex/intent-runtime

npm 会自动安装所需依赖,包括 schema-dsl,无需另行安装。使用 Node.js 20 及以上随附的 npm 即可。

安装后可以检查依赖并确认导出可加载:

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

最后一条应输出 function,只验证导出可加载,不调用模型。接下来运行快速开始的 JavaScript / TypeScript 示例。

全局安装与登记 Codex

需要在 Codex 中使用,或直接启动独立 MCP 服务时,安装全局命令:

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

全局安装不修改宿主配置。继续Codex 接入保存配置并显式 setup;host 使用当前模型,不需要额外 API Key。独立 stdio 服务不必登记 Codex。

独立 MCP(stdio/HTTP)与 Codex 的启动/诊断需要包的可选 MCP SDK 依赖,默认安装会包含它们;使用 --omit=optional 安装时不包含这条启动能力。Native/API 及 SDK 无关的 adapter 入口有独立验证范围,见兼容与支持。

CLI 配置接受可信的绝对 .js / .mjs 路径。.js 使用 ESM 项目配置;.mjs 可独立保存。TS 配置先编译成 ESM .js 再传给 CLI,Node 20 不提供通用的原生 TS 执行。全局安装不会使任意配置文件都能导入全局包;需要导入 Builder 或 API adapter 时,将配置放在装有本地依赖的项目中。示例源码可从对应页面复制。

更新

在应用目录重新执行 npm install @devcodex/intent-runtime;全局命令使用 npm install -g @devcodex/intent-runtime。更新内容见更新日志。Codex 的检查、修复、清理、命令选项与退出码见安装维护。本模块不会自动下载或覆盖你的业务配置。