AIntent Documentation

AIntent is an intent alignment gate for LLM applications. It ensures that AI-generated outputs align with actual user intent before delivery.

AIntent is available as a Hosted SaaS product and as a local-first OSS runtime. Both share the same core alignment engine.

Two ways to use AIntent OSS:
  • npm install for CLI + stdio MCP runtime
  • Repo build for source tree + local dashboard

On this docs page, OSS commands use the aintent binary. The hosted SaaS CLI remains aints.

Choose a Path

Pick the setup that fits your workflow.

Hosted SaaS
Managed
Managed web and account-based usage. No local setup required.
  • Hosted dashboard
  • Account management
  • REST API + MCP
  • ChatGPT App
  • Claude Web
Get Started
OSS via npm
Fastest
Local runtime with the least setup. CLI and stdio MCP included.
  • CLI interface
  • stdio MCP transport
  • Local SQLite storage
  • Session export
  • No dashboard included
Install Guide
OSS via Repo Build
Full Control
Source tree with local dashboard. Optional customization.
  • Everything in npm
  • Local dashboard app
  • Editable source code
  • Custom extensions
  • No customization required
Build Guide

Hosted SaaS

The managed AIntent product. No local build required.

  • Hosted dashboard for session management and analytics
  • Account management and API key provisioning
  • Managed REST API and hosted MCP connectivity
  • ChatGPT App and Claude Web integrations

Hosted SaaS supports two practical access patterns: web surfaces and CLI-connected agent workflows.

Get Started with SaaS

OSS via npm

The fastest path to a local AIntent runtime. Includes CLI and stdio MCP transport.

This OSS path uses the aintent package and binary. The hosted SaaS CLI documented elsewhere on this site uses aints.

Install globally

npm install -g aintent

Or run directly with npx

npx aintent start

What you get

  • Local CLI interface (9 commands)
  • stdio MCP server (5 tools)
  • Local SQLite persistence
  • Session export to JSON
Note: The npm package does not include the dashboard web app. For the local dashboard, use the repo build path.

OSS via Repo Build

Clone the OSS repository and build locally. Includes the local dashboard and full source access.

Clone and build

git clone https://github.com/acord25/aintent.git
cd aintent && npm install && npm run build

Run the local dashboard

cd web && npm install && npm run dev

What you get

  • Everything in the npm package
  • Local dashboard web app
  • Editable source code
  • Ability to customize and extend
No customization required. The repo build works out of the box. Source-level customization is optional.

What's Included

Understand what each OSS path ships.

npm Includes

  • Local CLI (9 commands)
  • stdio MCP runtime (5 tools)
  • Local SQLite persistence
  • Session export to JSON
  • Package exports (store, stdio, local-api)

npm Does Not Include

  • Dashboard web app
  • SaaS account / login / billing
  • Hosted management surfaces
  • REST API

Repo Build Adds

  • Editable source code
  • Local dashboard web app
  • Ability to customize and rebuild
  • Full development toolchain

Configuration

Set up AIntent with your MCP host, CLI, or environment variables.

MCP Host Setup: Claude Desktop

Add to your Claude Desktop MCP configuration:

{
  "mcpServers": {
    "aintent": {
      "command": "npx",
      "args": ["-y", "aintent"]
    }
  }
}

MCP Host Setup: Cursor

Add to your Cursor MCP settings:

{
  "mcpServers": {
    "aintent": {
      "command": "npx",
      "args": ["-y", "aintent"]
    }
  }
}

Agent Skill Bootstrap

Install the bundled skill bootstrap for a supported agent. This does not generate Claude Desktop or Cursor MCP JSON:

These OSS bootstrap commands use aintent. The hosted SaaS CLI uses aints.

aintent init claude

Environment Variables

VariableDefaultDescription
AINTENT_DB_PATH~/.aintent/runtime.dbPath to the local SQLite database file.
AINTENT_EXPORT_DIR~/.aintent/exportsDirectory for exported session data.
LOG_LEVELinfoLogging verbosity (error, warn, info, debug).

Features

CLI commands, MCP tools, and alignment modes available in AIntent OSS.

CLI Commands (9)

CommandDescription
aintent startStart a new intent-alignment session
aintent signal <sessionId>Submit a structured signal for the current turn
aintent status <sessionId>Check the current status of a session
aintent set-mode <sessionId>Change the interview mode of a session
aintent disengage <sessionId>Disengage AIntent from an active session
aintent force-stop <sessionId>Force-stop a session immediately
aintent configView or update local configuration
aintent init <agent>Install the bundled Claude/Codex skill bootstrap
aintent exportExport session data from local storage

MCP Tools (5)

ToolDescription
create_sessionCreate a new intent-alignment interview session
process_signalSubmit a StructuredSignal and receive the next action
get_sessionRetrieve the current status of a session
disengage_sessionDisengage AIntent from an active session
set_modeChange the interview mode of a session

Alignment Modes

ModeMax TurnsThresholdDescription
off0N/ANo gating. LLM operates freely.
quick2080%Fast check for simple tasks.
standard4088%Default depth for most requests.
deep12092%Thorough analysis for complex tasks.

How It Works

AIntent runs an iterative alignment loop to discover and validate user intent before the LLM produces a final output.

Session Lifecycle

Intake
Intent Lock
Calibrate
Interview
Synthesize
Done
intakeIntake

Session created; initial context captured.

intent_lockIntent Lock

Initial intent structure and constraints are locked in before deeper probing.

calibrateCalibrate

Score alignment, assess domain fluency.

interviewInterview

Iterative question-answer loop to refine intent and resolve gaps.

synthesizeSynthesize

Generate final alignment summary and artifacts.

doneDone

Session complete with alignment verdict.

Scoring and Calibration

Each signal submitted by the LLM updates the alignment score based on slot coverage, specificity, confidence, and risk assessment. The engine calibrates domain fluency (L1 through L7) to adjust question depth and question layer while mode and risk settings determine the applicable score thresholds.

Artifacts

When a session reaches the "done" stage, the engine produces a structured alignment summary including the final score, slot states, unresolved items, risk assessments, and a recommended action.

Architecture

AIntent OSS is organized into focused modules, each with a single responsibility.

engine

Core alignment logic: scoring, calibration, state machine.

contracts

Shared types, schemas, and interfaces (Zod-validated).

api/mcp

MCP server exposing 5 tools over stdio transport.

store

Local SQLite persistence for sessions and signals.

export

Export session data to JSON files for external use.

local-api

Local contract seam for dashboards and integrations without coupling directly to SQLite internals.

observability

Structured logging and diagnostics.

Data Flow

LLM HostMCP / CLIEngineStore

Signals flow from the LLM host through the transport layer into the engine, which persists state in the local store and returns action responses.

Extension Points

  • Store: Swap the default SQLite store with a custom persistence adapter.
  • Export: Add custom export formats beyond JSON.
  • Local API: Extend the local contract layer for dashboard integrations.

FAQ

Does the npm package include the dashboard?

No. The npm package ships CLI + stdio MCP + local runtime only. The dashboard web app is available when you clone and build from the OSS repository.

Is the alignment engine the same in SaaS and OSS?

Yes. Both use the same core alignment engine. SaaS adds managed infrastructure, hosted dashboard, account management, and REST API on top.

When should I use npm vs repo build?

Use npm for the fastest local setup with CLI and stdio MCP. Use repo build when you want the local dashboard or source-level customization.

Do I need to customize code when building from the repo?

No. Repo build works out of the box. Source-level customization is optional, not required.

Can I migrate from OSS to SaaS later?

Yes. The alignment engine is the same, so your workflows transfer. SaaS adds hosted features like account management and REST API access.

What MCP hosts are supported?

Any MCP-compatible host can be wired manually. Tested configurations include Claude Desktop and Cursor. The init command installs Claude/Codex skill bootstrap files; it does not generate Claude Desktop or Cursor MCP JSON for you.

Which Path?

A quick guide to choosing the right setup.