@smartergpt/axf
v1.0.0
Published
Agent eXoskeleton Framework control plane for workspace-native agent capabilities.
Readme
AXF
Agent eXoskeleton Framework for workspace-native agent capabilities.
AXF (Agent eXoskeleton Framework) gives teams a framework for building workspace-native agent exoskeletons: small, self-describing capabilities that encode how each codebase is built, tested, searched, diagnosed, and operated safely.
The goal is not to automate judgment. The goal is to compress repeated local ceremony into reliable workspace capabilities, so agents can spend more attention on the actual problem.
When AXF helps
- agents keep guessing which build, test, or validation command applies
- agents repeatedly search for the same repo facts before editing
- local safety rules live in prose, convention, or human memory
- brittle shell chains keep getting rebuilt for repo-specific chores
AXF is not
AXF is not a universal command catalog, a replacement for judgment, or an MCP-only product. It is the framework and control plane for building workspace-native agent exoskeletons from workspace-owned capabilities. MCP is one adapter surface; workspaces own the repo-specific capabilities agents use as their local exoskeleton.
Status: alpha. The core loop is in place: scout, inspect, execute, scaffold, and promote capabilities through one contract. Manifest version
axf/v0is the current alpha contract.
Install and MCP
License
AXF is source-available under the custom personal-use license in
LICENSE. It is not open source.
Permitted use is limited to personal, non-commercial evaluation, development, and local execution.
Redistribution, resale, sublicensing, commercial use, business use, production use, internal organizational use, SaaS use, managed-service use, and embedding in another product, service, SDK, platform, agent, workflow system, or commercial tooling require a separate written license.
The npm package name is @smartergpt/axf. It installs two bins:
axf— the CLI entrypoint, including the stdio MCP launch subcommandaxf mcpaxf-mcp— the stdio MCP server entrypoint
MCP clients may launch axf-mcp directly. For registry-driven or
package-driven launch, prefer axf mcp so the package can stay centered
on the base axf command surface. Both entrypoints start the same stdio
MCP server. The server exposes exactly one MCP tool named axf, and
that tool routes into AXF's existing capability surface for the bound
workspace.
Global install
npm install --global @smartergpt/axfThen use either bin directly:
axf doctor
axf mcp
axf-mcpRepo-local dev launch
From a local clone, run the bins directly with Node:
node /path/to/axf/bin/axf.js doctor
node /path/to/axf/bin/axf.js mcp
node /path/to/axf/bin/axf-mcp.jsA repo-local MCP configuration can either call the direct MCP bin or the CLI subcommand. Prefer the CLI subcommand when the client supports command arguments cleanly:
{
"mcpServers": {
"axf": {
"command": "node",
"args": ["/path/to/axf/bin/axf.js", "mcp"],
"cwd": "/path/to/project",
"env": {
"AXF_PROJECT_ROOT": "/path/to/project",
"AXF_EXECUTION_ROOT": "/path/to/project"
}
}
}
}Direct-bin configs remain valid:
{
"mcpServers": {
"axf": {
"command": "node",
"args": ["/path/to/axf/bin/axf-mcp.js"],
"cwd": "/path/to/project",
"env": {
"AXF_PROJECT_ROOT": "/path/to/project",
"AXF_EXECUTION_ROOT": "/path/to/project"
}
}
}
}npm / npx launch
Published-package smoke tests must run from a clean directory such as
/tmp, not from the AXF repo root. Running from the repo root can let
npx or npm exec pick up a repo-local or globally installed axf
binary instead of the package-installed one.
The registry-friendly launch shape is axf mcp, but the direct MCP bin
remains valid for manual configurations. These equivalent package-driven
forms use the published npm package:
npx -y --package @smartergpt/axf axf doctor
npx -y --package @smartergpt/axf axf mcp
npx -y --package @smartergpt/axf axf-mcp
npm exec --yes --package @smartergpt/axf -- axf doctor
npm exec --yes --package @smartergpt/axf -- axf mcp
npm exec --yes --package @smartergpt/axf -- axf-mcpWindows-native launch
For registry-style Windows MCP configs, prefer the base axf.cmd
launcher with mcp as an argument:
{
"mcpServers": {
"axf": {
"command": "axf.cmd",
"args": ["mcp"],
"cwd": "C:\\src\\my-project",
"env": {
"AXF_PROJECT_ROOT": "C:\\src\\my-project",
"AXF_EXECUTION_ROOT": "C:\\src\\my-project"
}
}
}
}Direct-bin .cmd configs are still valid:
{
"mcpServers": {
"axf": {
"command": "axf-mcp.cmd",
"args": [],
"cwd": "C:\\src\\my-project",
"env": {
"AXF_PROJECT_ROOT": "C:\\src\\my-project",
"AXF_EXECUTION_ROOT": "C:\\src\\my-project"
}
}
}
}WSL / Linux launch
For registry-style WSL/Linux MCP configs, prefer the base axf command
with mcp as the first argument:
{
"mcpServers": {
"axf": {
"command": "axf",
"args": ["mcp"],
"cwd": "/home/user/src/my-project",
"env": {
"AXF_PROJECT_ROOT": "/home/user/src/my-project",
"AXF_EXECUTION_ROOT": "/home/user/src/my-project"
}
}
}
}Direct-bin configs remain valid:
{
"mcpServers": {
"axf": {
"command": "axf-mcp",
"args": [],
"cwd": "/home/user/src/my-project",
"env": {
"AXF_PROJECT_ROOT": "/home/user/src/my-project",
"AXF_EXECUTION_ROOT": "/home/user/src/my-project"
}
}
}
}WSL users should use a native WSL AXF install on PATH, not Windows npm
shims or npm's _npx cache. Optional shared packs that launch native
CLIs should follow the same rule: prefer Linux-native tools earlier on
PATH and avoid crossing into Windows shims from WSL.
Root binding
axf, axf mcp, and axf-mcp resolve the active project root and
execution root in this order:
- explicit
--project-rootand--execution-root AXF_PROJECT_ROOTandAXF_EXECUTION_ROOT- legacy aliases:
--workspace,--registry-workspace,--execution-workspace,AXF_WORKSPACE,AXF_REGISTRY_WORKSPACE,AXF_EXECUTION_WORKSPACE - nearest
axf.workspace.jsonfromcwd - nearest
axf.workspace.jsonfrom the installed script location cwdfallback
When discovery and execution should use the same repo, set both
AXF_PROJECT_ROOT and AXF_EXECUTION_ROOT to the same path. When they
should differ, set them independently. Legacy AXF_WORKSPACE remains a
compatibility alias that binds both roots to one path.
For MCP clients, set cwd to the intended caller execution directory and
set AXF_PROJECT_ROOT / AXF_EXECUTION_ROOT explicitly when possible.
That keeps manifest discovery and caller-facing execution deterministic.
Set AXF_MACHINE_ROOT when you want a user- or machine-scoped AXF root
to contribute optional shared packs across projects. Project-root
families shadow machine-level families with the same family name.
From any directory once installed:
axf doctor
axf list
axf inspect echo say
axf run echo say --message hello
axf scout --check
axf run toy echo say --message hello
axf init capability global.acme.statusaxf doctor reports the workspace source it selected and, under WSL,
warns when axf, lex, node, or npm resolve through Windows PATH
entries under /mnt/c/....
MCP routing and governance
The MCP server exposes one tool named axf. Supported operations are:
helplistinspectrundoctorscout_check
Those operations route into AXF's manifest-backed discovery, resolver, lifecycle, policy, adapter, and executor paths. MCP does not add a second governance model or a raw shell bypass around AXF.
AXF MCP is intentionally not full CLI parity yet. The CLI remains the
authoritative mutation and control plane for commands such as init,
promote, demote, scout --write, and other registry/materialization
flows.
Capabilities such as global.echo.say are not
separate MCP tools. Use operation=help to learn the router contract,
operation=list to discover capabilities, and operation=inspect
before operation=run. Treat capability
lifecycleState, sideEffects, policies, and workspace binding as
part of the execution contract.
scout_check is AXF's MCP-specific read-only structured scout
diagnostics surface. It is not intended to promise literal CLI parity
with axf scout --check.
Registry and manifest updates still happen through normal AXF CLI and filesystem/control-plane flows. The MCP server reloads registry state per request, so external AXF updates become visible on later MCP calls without restarting the server.
Full CLI parity may be considered later behind explicit policy and approval gates.
Shared packs appear through AXF only when the bound AXF project root or machine layer discovers or mounts those capabilities.
What's wired up
Built-in adapters
AXF ships two public built-in adapter types:
internal— runs handlers in-process (adapters/internal/)cli— generic subprocess dispatcher with stdout JSON parsing (adapters/cli/)
Shared command families use the same adapter contract as project-owned
capabilities. A shared pack can use the generic cli adapter, a
provider adapter, or an internal handler, but AXF core does not require
that pack as a runtime dependency.
Built-in capabilities
| Capability | Provider | Lifecycle | Notes |
|---|---|---|---|
| global.echo.say | internal | active | smallest in-process capability example |
Optional shared packs, including a Lex pack, can be added at machine or project scope. They route through the same resolver, lifecycle, policy, adapter, and executor path without defining the framework itself.
Toolspaces
toy— smallest mount example; re-mountsecho.saywith a local default
Repo onboarding
The recommended repo flow is:
- Add
axf.workspace.jsonat the repo root so workspace binding is explicit. - Add shared packs intentionally at machine or project scope when a repo wants them.
- Add repo-specific capabilities separately under
manifests/capabilities/ormanifests/families/. - Keep MCP optional; AXF works as a plain CLI capability router without it.
- Mark mutating capabilities with
sideEffects: "write". AXF does not yet have a first-classapprovalRequiredfield, so approval gates stay a repo policy or review convention for now.
See docs/13-repo-onboarding.md for the concrete onboarding pattern and platform notes.
How to add a new provider
The contract is open. Every new provider goes through the same scaffolders and lifecycle gates:
# 1. Scaffold a draft provider adapter (only if the provider has an
# envelope or quirks the generic cli adapter shouldn't carry):
axf init adapter --kind provider acme --composes cli
# 2. Scaffold each capability:
axf init capability global.acme.status
# 3. Edit the drafts, then:
axf doctor
axf run acme status --any-lifecycleThe four canonical prompts under prompts/ walk an agent
through discovery → planning → scaffolding → review against the actual
file contract. JSON-first providers can usually use the generic cli
adapter directly; provider adapters are for wrappers that need envelope,
error, or argument normalization beyond the generic route.
Layout
axf.workspace.json # workspace marker
bin/axf.js # CLI entrypoint
src/cli/ # CLI parsing + main dispatch
src/core/ # registry, resolver, executor, adapters, doctor, policy
adapters/<type>/ # type adapters (internal, cli, ...)
adapters/<provider>/ # optional provider adapters for wrapped CLIs
manifests/capabilities/ # capability manifests
manifests/toolspaces/ # toolspace mount manifests
prompts/ # canonical prompts for agent-authored adapters
docs/ # architecture, contract, lifecycle, prompts
test/ # node:test suiteReading order
docs/00-foundation.md— why axf existsdocs/01-vocabulary.mddocs/02-architecture.mddocs/03-capabilities-and-manifests.mddocs/04-adapter-contract.md— the two-kind adapter model (type + provider)docs/05-lifecycle-and-promotion.mddocs/06-canonical-prompts.mddocs/07-v0-bootstrap-plan.md— alpha implementation milestonesdocs/08-adapter-folder-shape.md— the concrete file contractdocs/09-launch-plans.md— interpreter-aware launch plans, env-bound roots, fallback pathsdocs/10-command-families.md— family imports, public-to-provider arg mapping, materialization, driftdocs/11-normalization-guidance.md— JSON-first vs text-first providers, when to write a provider adapterdocs/12-layered-docs.md— caller / integrator / author paths through the docsdocs/13-repo-onboarding.md— workspace markers, shared packs, and platform guidancedocs/14-family-identity-and-layer-precedence-plan.md— family identity, layer precedence, and optional shared-pack direction
Tests
npm testUses Node's built-in node:test; no external test runner is required.
What is intentionally not here
- a broad command-alias layer
- privileged integration paths
- a plugin marketplace
- mandatory remote execution or MCP support
- agent-generated capabilities that auto-promote
