Installation
Invokta is distributed as focused ESM packages. Start with @invokta/core, then
install only the adapters and development tools your engine uses. The selected
channels do not change the capability implementation, so the engine remains
independent of one agent harness.
Requirements
Section titled “Requirements”- Node.js 22.20.0 or later
- An ESM project (
"type": "module") - A schema library that implements Standard Schema v1 and Standard JSON Schema v1
The examples use Zod 4 because it implements both schema contracts.
Create a standalone engine
Section titled “Create a standalone engine”npm create invokta-engine@latest my-enginepnpm create invokta-engine my-engineyarn create invokta-engine my-engineThe creator asks for one of four profiles. complete generates direct, CLI, MCP
stdio, and MCP HTTP entry points; cli, mcp-stdio, and mcp-http generate
only direct invocation plus the selected adapter. Use --no-install for an
offline scaffold. See the
create-invokta-engine reference for
automation flags, target safety, package-manager behavior, and profile contents.
After validating a complete or mcp-stdio project, install its local MCP
server in detected clients with one command:
cd my-enginenpm run checknpm run mcp:install# Later, remove the engine from every managed MCP client:npm run mcp:uninstallThe script builds first, preselects every eligible client, and requires one confirmation before writing user configuration. The build-free uninstall script uses the manifest ID to remove that engine from every installer-managed client after one confirmation, even when its compiled entry point is absent. See the installer reference for supported clients, remote HTTP registration, and lifecycle management.
Create reusable capability packages
Section titled “Create reusable capability packages”Create one atomic exported capability:
npm create invokta-capability@latest my-capabilityCreate a related capability library:
npm create invokta-capability-library@latest my-libraryBoth starters are private, deterministic ESM packages. Their tests compose the
generated exports into an engine and invoke them through engine.invoke. See
the atomic creator and
capability-library creator
references for the complete contracts.
Install the core
Section titled “Install the core”npm install @invokta/core zodpnpm add @invokta/core zodyarn add @invokta/core zodAdd execution channels
Section titled “Add execution channels”Install the CLI or MCP adapter when the engine needs that boundary.
npm install @invokta/cli @invokta/mcppnpm add @invokta/cli @invokta/mcpyarn add @invokta/cli @invokta/mcp| Package | Use it for |
|---|---|
@invokta/core |
Capabilities, engines, contracts, errors, and events |
@invokta/cli |
list, describe, and run commands |
@invokta/mcp |
MCP tools over stdio or stateless Streamable HTTP |
@invokta/tooling |
Capability-composition checks during development |
@invokta/devtools |
MCP and CLI workbenches, engine dev server, web inspector, and doctor diagnostics |
@invokta/installer |
Install and manage local or remote Action Engine MCP servers in supported clients |
@invokta/deploy |
Reviewable container packaging and endpoint probes |
create-invokta-engine |
Standalone starter Action Engine creation |
create-invokta-capability |
Standalone atomic capability package creation |
create-invokta-capability-library |
Standalone capability-library package creation |
Work inside this repository
Section titled “Work inside this repository”Clone the repository and install from its root when contributing to Invokta or running the included examples:
git clone https://github.com/vinilana/invokta.gitcd invoktacorepack enableyarn install --frozen-lockfile --non-interactiveyarn buildRead the repository’s
CONTRIBUTING.md
before editing. It covers branch preparation, the test-first delivery loop,
focused and full validation, contract review, and commit evidence. The public
documentation application is isolated from the root workspace; changes under
apps/docs/ also require its local yarn validate gate.
Continue with your first engine. The package reference overview links the complete public API and command contract for every package.