Skip to main content

Deterministic agent-management framework that implements FRAME governance for AI-assisted software development.

Project description

Haxaml

PyPI version

MCP-first, Git-style workflow governance for AI coding agents.

Most AI coding issues do not begin when an agent writes bad code. They begin earlier, when the agent jumps from a vague request straight into implementation without understanding the project, the missing context, the risks, or what "done" actually means.

Haxaml is a token and context-efficient engine built on top of FRAME: a simple model that splits project understanding into five parts: Facts, Rules, Acts, Map, and Expect.

Instead of dumping the whole project into an agent and hoping it figures things out, Haxaml gives the agent a governed workflow. It helps the agent prepare before coding, pull only the context needed for the task, verify the work with evidence, and record useful state for the next agent.

The result is a calmer agent workflow: less guessing, less context bloat, better handoffs, and a project state that can travel across Claude Code, Codex CLI, Cursor, Copilot, Windsurf, and any MCP-compatible agent.

What Haxaml Is Not

  • Not an AI memory backpack. Haxaml is not mainly about storing random facts for an agent to recall later. It is about shaping project understanding so agents can prepare, plan, verify, and record their work properly.
  • Not just a prompt file. AGENTS.md, CLAUDE.md, Cursor rules, Copilot instructions, and similar files are adapters. Haxaml is the governed engine underneath them.
  • Not a replacement for your agent. Haxaml does not write the code for the agent. It gives the agent a workflow spine so the work starts with context, follows project rules, and ends with verification.
  • Not a giant context dump. Haxaml is built to reduce context noise by giving the agent the right project signals at the right time.

How It Works

Haxaml exposes a lifecycle through MCP tools. The agent follows this flow before, during, and after implementation:

Phase Tool(s) What happens
about haxaml_about The agent learns what Haxaml is, what FRAME means, and how to operate inside the project
guidance haxaml_guidance Haxaml classifies the request and decides whether it is governed project work or a utility task
prebuild haxaml_prebuildhaxaml_context_pack Agent classifies the task, checks FRAME readiness, opens a governed session, then pulls the first task-scoped context pass
retrieve haxaml_context_fetch (optional, repeatable) Agent asks for more governed memory only when the first context pass is not enough
build (no Haxaml tool) The agent edits files, writes code, runs commands, answers a question and performs the actual implementation
verify haxaml_session_verify The agent records what it inspected, what it changed, what was checked, and what risks remain
record haxaml_session_recordhaxaml_expect_sync The outcome is written into project history and expectations are synced for future work

In short:

about → guidance → prebuild → context_pack → [context_fetch]* → build → verify → record → expect_sync

Project memory lives in .haxaml/ — versioned files your agent uses at runtime, not a static wall of text. Older acts history is kept in .haxaml/archive/acts-history.yaml and pulled back only on demand.

In 0.6.7b0, long-lived runtimes also stop rereading unchanged FRAME files blindly. Repeated context_pack calls now compare the current runtime snapshot to the earlier session snapshot, report what changed, and return smaller refresh deltas when only part of the governed context moved.

Install

Haxaml now ships as three related packages:

  • haxaml - core FRAME governance engine and CLI
  • haxaml-mcp - MCP launcher/runtime package
  • haxaml-ui - local read-only dashboard package, beta in 0.6.7b0

Common install paths:

pip install haxaml
pip install haxaml-mcp
pip install haxaml-ui
pip install "haxaml[ui]"

If you want to run the MCP server without a persistent install:

uvx haxaml-mcp

For persistent local installs:

uv tool install haxaml-mcp

Local Dashboard

The first dashboard release is intentionally narrow:

  • browser UI, not TUI
  • localhost only
  • read-only
  • overview-first
  • all five FRAME files rendered
  • archive summary plus drilldown

Launch it with:

haxaml dashboard

Supported flags:

  • --project-dir
  • --host
  • --port
  • --no-open
  • --read-only

Install note:

  • haxaml dashboard is the primary human launcher
  • haxaml[ui] is the install selector
  • haxaml-ui is the separate dashboard distribution

MCP Start

Configure your MCP client to launch haxaml-mcp. For project-scoped configs, cwd is enough. For user-wide configs, set HAXAML_PROJECT_DIR to the project root. See learn/haxaml-mcp.md for the full MCP/architecture guide.

Once connected, agents can initialize and validate through MCP tools:

  • haxaml_init
  • haxaml_validate

Optional fallback: run haxaml init / haxaml validate directly when MCP is unavailable.

MCP Config

Official docs:

Project-scoped (recommended)

Place config in the project root. The server uses cwd as the project directory — no env var needed.

Claude Code.mcp.json in project root:

{
  "mcpServers": {
    "haxaml": {
      "command": "uvx",
      "args": ["haxaml-mcp"]
    }
  }
}

Codex CLI.codex/config.toml in project root:

[mcp_servers.haxaml]
command = "haxaml-mcp"

Generic MCP JSON (Windsurf, Cursor, etc.):

{
  "mcpServers": {
    "haxaml": {
      "type": "stdio",
      "command": "uvx",
      "args": ["haxaml-mcp"]
    }
  }
}

User-wide

Set HAXAML_PROJECT_DIR to pin the server to a specific project regardless of cwd. Useful for global configs that live outside the project.

Claude Code~/.claude.json:

{
  "mcpServers": {
    "haxaml": {
      "command": "uvx",
      "args": ["haxaml-mcp"],
      "env": {
        "HAXAML_PROJECT_DIR": "/absolute/path/to/project"
      }
    }
  }
}

Codex CLI~/.codex/config.toml:

[mcp_servers.haxaml]
command = "haxaml-mcp"
env = { HAXAML_PROJECT_DIR = "/absolute/path/to/project" }

Generic MCP JSON:

{
  "mcpServers": {
    "haxaml": {
      "type": "stdio",
      "command": "uvx",
      "args": ["haxaml-mcp"],
      "env": {
        "HAXAML_PROJECT_DIR": "/absolute/path/to/project"
      }
    }
  }
}

Bootstrap Prompt

Paste this into your native agent instruction file (AGENTS.md, CLAUDE.md, GEMINI.md, .github/copilot-instructions.md, etc.):

This repository uses Haxaml for agent governance.

Use the Haxaml MCP server for governed project work.
Before governed project work, call haxaml_about(project_dir='.') once in the active MCP session.
Follow the workflow returned by that tool.
If a governed step is skipped or out of order, treat Haxaml contract errors as hard blockers and fix the lifecycle step before continuing.
Do not edit .haxaml/* for utility or side tasks that are not governed project work.

FRAME Files

  • .haxaml/facts.yaml - project truth
  • .haxaml/rules.yaml - agent operating rules
  • .haxaml/acts.yaml - execution diary and decisions
  • .haxaml/expect.yaml - run plan and milestones
  • .haxaml/map.yaml - optional module ownership and impact map

Docs

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

haxaml-0.6.7b0.tar.gz (151.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

haxaml-0.6.7b0-py3-none-any.whl (149.1 kB view details)

Uploaded Python 3

File details

Details for the file haxaml-0.6.7b0.tar.gz.

File metadata

  • Download URL: haxaml-0.6.7b0.tar.gz
  • Upload date:
  • Size: 151.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.11 {"installer":{"name":"uv","version":"0.11.11","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for haxaml-0.6.7b0.tar.gz
Algorithm Hash digest
SHA256 28de472245a6f1f269d67e05e84e61ffb4a8b33e2f54805057c2caf071b4479b
MD5 a288edeb19f65852f4ed1c466e38eba7
BLAKE2b-256 5149effa3cccd4187946f9481ca9a53df5c1d184ebb1e82c149ca92b2903f5c7

See more details on using hashes here.

File details

Details for the file haxaml-0.6.7b0-py3-none-any.whl.

File metadata

  • Download URL: haxaml-0.6.7b0-py3-none-any.whl
  • Upload date:
  • Size: 149.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.11 {"installer":{"name":"uv","version":"0.11.11","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for haxaml-0.6.7b0-py3-none-any.whl
Algorithm Hash digest
SHA256 f6e9724bf3fc3fee1011da6231aad0baf1ec6d4b9db25b7b3dc8ab5c2368329a
MD5 4bf39a19eb1f0409c695c8f6ee016211
BLAKE2b-256 27c0be5bf9b2ba7c9197ed1d10e9e9ed2e36150c14cf57157a74ef8de698e78b

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page