agenthealth

module
v0.12.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 9, 2026 License: Apache-2.0

README

TheAgentHealth

See the all-phase status index for implementation, documentation, and example coverage across Phases 0–26.

Universal Health & Readiness Framework for Agentic Systems

AgentHealth is an open-source, vendor-neutral, framework-neutral, and language-neutral project for determining whether AI agents and the infrastructure they depend on are reachable, correctly configured, responsive, ready, and operationally healthy.

Start here

Last published CLI: v0.11.1, pre-1.0; v0.12.0 is prepared in source. Supported adapters: agent/multi-agent, HTTP/API, MCP HTTP/stdio, A2A, gateway, and router. Model, database, and vector-store adapters are planned; schema vocabulary does not imply adapter availability.

Install

Download the archive for your platform from GitHub Releases, verify its checksum, and extract it. Downloaded binaries do not require Go. See installation instructions for platform commands and provenance verification.

The last published v0.11.1 container is available at ghcr.io/theagenthealth/agenthealth:v0.11.1 and Docker Hub at theagenthealth/agenthealth:v0.11.1; see Docker distribution.

Phase 13 package assets are included starting in v0.11.0: Homebrew/Scoop manifests and Linux DEB/RPM packages. Public taps, buckets and package repositories remain deferred. See package channels and the alignment audit.

60-second example

Run a passive HTTP check against an endpoint you control:

./agenthealth version
./agenthealth ping http http://localhost:8080/health

For a configuration file, save this as agenthealth.yaml:

version: v1
targets:
  - name: local-api
    type: http
    endpoint: http://localhost:8080/health
    checks:
      - reachability
      - protocol
./agenthealth check agenthealth.yaml --format json
./agenthealth doctor agenthealth.yaml

A reachable endpoint returning HTTP 200 should produce HEALTHY and exit code 0; an unavailable endpoint produces UNREACHABLE and exit code 3. See sample output and CLI usage for all statuses and exit codes.

Configuration is trusted executable input. Review commands, endpoints, credential references, and token-file paths before running a configuration. See the security boundary.

Architecture and scope

Think of AgentHealth as:

ping + curl + doctor + Kubernetes health probes for the Agentic AI ecosystem.

The long-term scope includes these systems; the supported adapters above describe what ships today:

  • AI agents
  • Multi-agent systems
  • Agent-to-Agent (A2A) endpoints
  • MCP servers
  • MCP tools and resources
  • LLM and model endpoints
  • External tools
  • APIs
  • Vector databases
  • Databases
  • Agent runtimes
  • Agent gateways
  • Agent routers
  • Supporting infrastructure

The project provides a common health model, a Go engine, a CLI, machine-readable health results, agent/multi-agent, HTTP/API, MCP, A2A, gateway and router adapters, and a published container image (see Docker distribution); Kubernetes manifests and independently published Helm chart 0.1.0 are available (Phase 14 guide); SDKs and additional adapters remain roadmap work.

Release preparation: v0.12.0. Last published CLI: v0.11.1. v0.12.0 coordinates Docker, Helm and standalone/package downloads under one version, with additional OCI chart and binary packages. The workflow and installation examples below are prepared in source; publication is pending an authorized tag. See release notes. Phase 13 adds Homebrew/Scoop manifests, Linux DEB/RPM packages and five-platform native archive smoke checks. See release notes. Phase 12 adds an official container image published to GHCR with an optional Docker Hub mirror, build provenance, SBOM, and a signed attestation. See release and migration notes. Phase 8 adds Agentgateway HTTP health signals and separate configured backend/path evidence. Phase 10 adds shared dependency graphs, independent edge policies and bounded parallel execution in v0.8.0. See v0.8.0 release notes. Phase 7 adds direct/composite agent health, declared liveness/readiness, capability and dependency discovery, and safe task/path probes. Path probes require a receiving handler in the first agent application. This release retains A2A 1.0 with explicit 0.3.0 compatibility and signed provenance/SBOM attestations. See v0.9.0 release notes.


Why AgentHealth?

Traditional health checks answer questions such as:

Is the process running?
Is port 8080 open?
Does /health return HTTP 200?

Those checks are necessary, but they are often insufficient for agentic AI systems.

An agent can return HTTP 200 while being unable to perform useful work because:

  • its model endpoint is unavailable,
  • an MCP server cannot initialize,
  • authentication has expired,
  • a required tool is unavailable,
  • a vector database cannot be reached,
  • an A2A peer is unreachable,
  • required capabilities are missing,
  • the agent runtime is misconfigured,
  • dependencies are experiencing excessive latency,
  • or a minimal agent execution fails.

AgentHealth is intended to answer the more useful operational question:

Can this agentic system actually perform the work it is expected to perform right now?


Project Goals

AgentHealth aims to provide:

  1. A vendor-neutral health model for agentic systems.
  2. A language-neutral Agent Health Specification.
  3. An experimental Agent Health Protocol (AHP) HTTP v1 binding for exchanging health, implemented in source.
  4. A universal command-line interface.
  5. Health checks for common agent protocols and infrastructure.
  6. Dependency-aware health diagnostics.
  7. Machine-readable results for automation.
  8. SDKs for application integration.
  9. Docker/container distribution.
  10. Kubernetes-native health and readiness integration.
  11. CI/CD deployment validation.
  12. An extensible adapter/plugin model.
  13. A community-driven interoperability layer for agentic infrastructure.

Specification → Protocol → Implementation

AgentHealth separates what health means from how health is exposed from the tools intended to implement it (see Project Status for implemented and planned components).

                    TheAgentHealth
                          │
          ┌───────────────┼────────────────┐
          │               │                │
          ▼               ▼                ▼
 Agent Health       Agent Health       Reference
 Specification      Protocol (AHP)    Implementation
 (AHS)              [proposed]
          │               │                │
          │               │         ┌──────┼────────┐
          │               │         │      │        │
          │               │        CLI    SDK     Docker
          │               │                       / Helm
          │               │
          ▼               ▼
 Defines WHAT       Defines HOW
 health means       health is exposed
                    and exchanged

Agent Health Specification (AHS)

The specification defines the vocabulary and health model that the rest of the project builds on:

HEALTHY
DEGRADED
UNHEALTHY
UNREACHABLE
MISCONFIGURED
UNKNOWN

Reachability
Protocol Health
Authentication
Capability Health
Functional Health
Dependency Health
Latency Health
Configuration Health

This is documented throughout this README (see Core Concepts and Standard Health States) and is the most mature layer of the project today.

Agent Health Protocol (AHP) — experimental HTTP v1

Experimental HTTP v1 serving is included in v0.9.0. agenthealth serve exposes public /health, /ready and /live summaries and bearer-authorized /health/dependencies and /health/capabilities evidence. See the protocol contract and serving guide. Independent interoperability and external standardization remain unverified.

Reference Implementation

The reference implementation is the concrete, versioned software that implements the specification and experimental HTTP protocol:

  • the agenthealth CLI,
  • language SDKs (Python, JavaScript/TypeScript),
  • Docker images and Helm charts,
  • Kubernetes integrations.

These are described in detail in Universal CLI, Distribution, and Kubernetes.

Naming

Concept Name
Organization TheAgentHealth
Project AgentHealth
Specification Agent Health Specification (AHS)
Protocol (experimental HTTP v1) Agent Health Protocol (AHP)
CLI agenthealth
Config file agenthealth.yaml
Python package agenthealth
npm package @agenthealth/sdk
Container image (GHCR / Docker Hub) ghcr.io/theagenthealth/agenthealth / theagenthealth/agenthealth
Helm chart agenthealth

What AgentHealth Is Not

AgentHealth is not intended to replace:

  • observability platforms,
  • distributed tracing systems,
  • metrics platforms,
  • logging systems,
  • evaluation frameworks,
  • security scanners,
  • model monitoring platforms,
  • API gateways,
  • MCP gateways,
  • or agent frameworks.

Those systems provide continuous visibility into application behavior.

AgentHealth focuses on a narrower operational problem:

Health, readiness, reachability, dependency validation, and diagnostics.

An observability platform may tell you how a system behaved over the last 24 hours.

AgentHealth should be able to tell you:

Can my agent work right now?

If not, what dependency is preventing it?

Core Concepts

AgentHealth separates health into multiple dimensions instead of treating health as a single HTTP status.

Reachability

Can AgentHealth establish communication with the target?

Examples:

  • TCP/HTTP connectivity
  • MCP transport connectivity
  • A2A endpoint availability
  • model API availability
  • database connectivity

Protocol Health

Does the target correctly support the expected protocol?

Examples:

  • MCP initialization
  • protocol version compatibility
  • A2A discovery
  • required endpoint validation
  • capability negotiation

Authentication

Can the configured identity authenticate successfully?

Examples:

  • API key validation
  • OAuth credentials
  • service credentials
  • workload identity
  • token validity

Secrets must never be exposed in AgentHealth output.


Capability Health

Does the target expose the capabilities required by the workload?

Examples:

  • MCP tools
  • MCP resources
  • agent skills
  • model availability
  • expected API operations
  • required runtime features

Functional Health

Can the target successfully perform a minimal operation that actually exercises it (not merely list what it claims to support)?

Examples:

  • minimal model inference request
  • lightweight API operation
  • database SELECT 1
  • vector store read operation

Functional checks are classified active (see Passive vs Active Checks): they never run by default and require being explicitly listed in a target's checks (see spec/configuration.md § Default Checks). Even when opted in, functional checks should remain minimal and non-destructive.


Dependency Health

Are the target's required dependencies healthy?

An agent may itself be reachable while one of its dependencies is not.

AgentHealth therefore supports dependency-aware health.

Example:

Research Agent
│
├── Model Endpoint .............. HEALTHY
│
├── GitHub MCP .................. HEALTHY
│
├── PostgreSQL MCP .............. DEGRADED
│
├── Search Tool ................. HEALTHY
│
└── Vector Database ............. UNREACHABLE

Overall: DEGRADED

Latency Health

AgentHealth can measure response latency and compare it against configurable thresholds.

Example:

Latency: 1,842 ms
Threshold: 1,000 ms

Status: DEGRADED

Configuration Health

AgentHealth can detect configuration problems that are identifiable before attempting to reach or operate the target, such as:

  • missing endpoint,
  • missing credentials,
  • invalid or unsupported protocol selection,
  • malformed configuration.

These are reported as:

MISCONFIGURED

rather than incorrectly labeling the target as unreachable.

Problems that can only be discovered by actually contacting the target — such as an incompatible protocol version returned during negotiation, or a required capability/model the target doesn't expose — are Protocol Health and Capability Health concerns instead, and resolve to UNHEALTHY (see spec/health-model.md § Error Classification).


Standard Health States

AgentHealth defines a common health vocabulary.

Status Meaning
HEALTHY Target is operating normally
DEGRADED Target works but one or more non-fatal conditions are impaired
UNHEALTHY Target is reachable but cannot perform required functionality
UNREACHABLE Target cannot be contacted
MISCONFIGURED Configuration prevents a valid health determination or operation
UNKNOWN Health cannot currently be determined

Adapters may expose additional diagnostic details while mapping their overall result to the common health model.


Universal CLI

The CLI supports agent, multi-agent, gateway, router, http, api, mcp, and a2a targets. See CLI usage for the complete command reference.

agenthealth ping http https://service.example.com/health
agenthealth ping mcp http://localhost:3000/mcp
agenthealth check agenthealth.yaml --format json
agenthealth doctor agenthealth.yaml
agenthealth doctor mcp http://localhost:3000/mcp
agenthealth ping a2a http://localhost:9000
agenthealth doctor examples/a2a-check/agenthealth.yaml
agenthealth version

Configured dependencies are evaluated automatically; no --dependencies flag is needed. The agent adapter is implemented; model adapters remain planned.


ping, check, and doctor

AgentHealth exposes three primary operational concepts.

agenthealth ping

Quickly determine whether a target is reachable and responding correctly.

agenthealth ping mcp http://localhost:3000

Example:

Conceptual display; see CLI usage for the implemented output and health states.

Target: github-mcp
Type: MCP

Reachability       PASS
Protocol           PASS
Authentication     PASS
Capabilities       PASS
Latency            84 ms

Status: HEALTHY

agenthealth check

Run standardized health policies.

agenthealth check agenthealth.yaml

This is designed for:

  • automation,
  • CI/CD,
  • production validation,
  • Kubernetes,
  • scheduled checks,
  • platform engineering workflows.

agenthealth doctor

Perform deeper diagnostics and explain why a system is unhealthy.

agenthealth doctor agenthealth.yaml

Conceptual future output (current doctor output is documented in CLI usage):

AgentHealth Doctor

✓ Agent endpoint reachable
✓ A2A discovery successful
✓ Model endpoint reachable
✓ Authentication valid
✓ GitHub MCP healthy
⚠ PostgreSQL MCP latency: 1,832 ms
✗ Search MCP unreachable
✓ Vector store healthy

2 issues detected.

Overall Status: DEGRADED

Supported Target Types

The long-term AgentHealth architecture is intended to support:

agent
multi-agent
a2a
mcp
tool
model
llm
http
api
vector-store
database
runtime
gateway
router
custom

Currently implemented target types in source are agent, multi-agent, http, api, mcp, a2a, gateway, and router (A2A 1.0 JSON-RPC with explicit 0.3.0 compatibility). The remaining types are specification vocabulary for future adapters.

See ROADMAP.md.


MCP Health

The MCP adapter supports Streamable HTTP JSON/SSE, configured stdio subprocesses, legacy initialization, and stateless MCP 2026-07-28. It checks authentication, paginated tools/resources/prompts, required inventories, and latency. Functional tool calls require explicit safe opt-in and never retry.

Feature Configuration example Documentation
Passive discovery and required inventories MCP discovery Checks and expectations
Modern stateless protocol Version pin Protocol selection
Local stdio server Subprocess configuration Stdio setup
OAuth client credentials Automated authentication OAuth setup
OAuth browser login + PKCE Interactive login configuration Login command
OAuth refresh tokens and rotation Refresh configuration Token refresh and storage
Explicit safe functional invocation Tool probe Functional safety

Point these commands at your server's actual MCP endpoint:

agenthealth ping mcp http://localhost:3000/mcp
agenthealth doctor mcp http://localhost:3000/mcp

For OAuth browser login, first replace the example's endpoint, issuer, and client ID with your registered server/client settings, then run:

agenthealth login examples/mcp-oauth/agenthealth.yaml user-mcp
agenthealth check examples/mcp-oauth/agenthealth.yaml

Health checks stay noninteractive; only login asks for browser approval. Tokens are stored privately and redacted from health output. Client credentials and refresh-token examples reference environment variables instead of literal secrets. See the examples guide for setup instructions and Phase 5 status for implemented scope.

Deprecated separate HTTP+SSE, dynamic OAuth client registration, and JWT client assertions are not implemented. The adapter documentation lists remaining protocol, transport, and platform limits.


A2A Health

The A2A adapter validates A2A 1.0 JSON-RPC with explicit 0.3.0 compatibility peers: agent card discovery and metadata, passive protocol/authentication checks, expected skills and capabilities, latency, and explicit safe interaction probes.

agenthealth ping a2a https://research-agent.example.com
agenthealth check examples/a2a-check/agenthealth.yaml --format json
Example Behavior
A2A v1 peer Default A2A 1.0 discovery and passive health checks
0.3.0 compatibility peer Explicit legacy protocol pin, discovery, read-only protocol/authentication checks, required skill, latency
Bearer credentials Environment-referenced token for passive checks
Custom card URL Discovery from a different path on the configured origin
Minimal interaction One explicitly enabled, operator-declared safe text probe

Examples require your own running peer and matching skill expectations. See the example setup guide and adapter guide for configuration, classifications, and supported scope. Other A2A versions and transports remain future work.


Agent Health

Implemented draft in Phase 7 — Agent Health. See the agent interface and examples.

Integration prerequisite: your agent application must expose the documented health resource. For a first-to-downstream path probe, the first agent must implement a safe POST handler that actually contacts the selected downstream agent and reports completion. AgentHealth sends and evaluates the probe; it does not install this handler into your application. Phase 7 is available in v0.5.0 and newer. This includes the user's first, user-facing agent, whether it answers directly or calls other agents. Checks cover its own endpoint, authentication, liveness, readiness, and capabilities, with an explicitly opted-in, bounded, non-destructive minimal task for functional validation.

Direct agent health checks the user's first, user-facing agent.

Composite agent health checks the downstream agents that the first agent communicates with, either through a direct integration or through A2A. Each downstream agent's own health and the communication path from the first agent should be checked separately.

Models, tools, MCP servers, data services, gateways, and routers are supporting dependencies; their checks are described as dependency health. Here, direct and composite describe agent roles in the interaction, not new target types. A multi-agent target describes the cooperating system as a whole. Results should distinguish first-agent, downstream-agent, communication-path, and supporting-dependency failures.

Point the command at a resource implementing the agent health interface:

agenthealth ping agent https://research-agent.example.com

Checks and supporting dependencies:

Endpoint
Agent metadata
Agent capabilities
A2A
Model dependency
MCP dependencies
Tool dependencies
Data dependencies
Minimal execution
Latency

Phase 8 Agentgateway integration supports read-only HTTP health signals and independently configured backend and protocol-path checks. Phase 9 Agent Router integration supports configured HTTP signals and named route/backend evidence in source. A failed proxied request alone cannot establish its cause.


Model / LLM Health

Planned adapter. The released CLI does not implement this target type. Use an explicitly configured HTTP health endpoint for HTTP-level evidence today; it does not establish functional model or database readiness.

AgentHealth can validate model dependencies without being tied to one provider.

Checks may include:

  • endpoint reachability,
  • authentication,
  • model availability,
  • minimal inference,
  • latency,
  • rate limiting,
  • provider errors,
  • malformed responses.

Provider-specific integrations should be implemented through adapters.


Tool and API Health

Generic HTTP/API checks enable AgentHealth to validate dependencies that do not implement an agent-specific protocol.

Checks can include:

DNS
TCP
TLS
HTTP status
Authentication
Response schema
Expected content
Latency

Vector Store Health

Planned adapter. The released CLI does not implement this target type. Use an explicitly configured HTTP health endpoint for HTTP-level evidence today; it does not establish functional model or database readiness.

Adapters may provide checks for vector infrastructure.

Examples:

  • connectivity,
  • authentication,
  • collection/index existence,
  • metadata access,
  • lightweight query,
  • latency.

Potential ecosystems include:

Pinecone
Qdrant
Weaviate
Milvus
pgvector
OpenSearch
Elasticsearch
and others

Provider integrations are expected to grow through community adapters.


Database Health

Planned adapter. The released CLI does not implement this target type. Use an explicitly configured HTTP health endpoint for HTTP-level evidence today; it does not establish functional model or database readiness.

Database checks may include:

  • connection establishment,
  • authentication,
  • minimal safe query,
  • connection latency,
  • read readiness.

Examples:

PostgreSQL
MySQL
Redis
MongoDB
and others

Dependency Graph

Dependency-aware diagnostics are implemented through Phase 10: explicit shared node IDs, per-edge critical policy and relationship labels, cycle detection, bounded parallel checks, independent node budgets, and ordered tree/JSON/YAML output. See the example and phase alignment audit. Graph fields require v0.8.0 or newer.

Example:

                    Research Agent
                          │
           ┌──────────────┼───────────────┐
           │              │               │
         Model           MCP            Vector DB
           │              │
       HEALTHY      ┌─────┴─────┐
                    │           │
                 GitHub       Database
                 HEALTHY      DEGRADED
                                  │
                              PostgreSQL
                              HIGH LATENCY

The engine calculates overall status using critical/optional dependency propagation and latency thresholds. More general health policy engines remain future work. The design accounts for:

  • critical dependencies,
  • optional dependencies,
  • health policies,
  • failure propagation rules,
  • latency thresholds.

AgentHealth Configuration

This example uses released adapters and requires configured services and an agent safe-task handler:

version: v1

targets:
  - name: research-agent
    type: agent
    endpoint: https://agent.example.com

    checks:
      - reachability
      - protocol
      - authentication
      - capability
      - functional
      - latency

    agent:
      functional:
        safe: true
        text: Return a fixed health acknowledgement without tools or writes.

    thresholds:
      latency_ms: 1000

    dependencies:
      - name: github-mcp
        type: mcp
        endpoint: http://github-mcp:3000
        critical: true

      - name: vector-store-health
        type: http
        endpoint: http://vector-db:6333
        critical: true

      - name: analytics-api
        type: http
        endpoint: https://analytics.example.com/health
        critical: false

The configuration specification will evolve independently of any particular implementation language. See spec/configuration.md for the normative field definitions and defaults.


Machine-Readable Health Format

AgentHealth is designed for both humans and machines.

Example JSON:

{
  "spec_version": "v1",
  "target": { "name": "research-agent", "type": "agent" },
  "status": "UNHEALTHY",
  "latency_ms": 182,
  "checks": {
    "reachability": { "status": "HEALTHY" },
    "authentication": { "status": "HEALTHY" },
    "protocol": { "status": "HEALTHY" },
    "capability": { "status": "HEALTHY" },
    "functional": { "status": "HEALTHY" },
    "latency": { "status": "HEALTHY" },
    "dependency": {
      "status": "UNHEALTHY",
      "message": "critical dependency vector-store is UNREACHABLE"
    }
  },
  "dependencies": [
    {
      "target": { "name": "github-mcp", "type": "mcp" },
      "status": "HEALTHY",
      "latency_ms": 84,
      "checks": { "reachability": { "status": "HEALTHY" } },
      "dependencies": []
    },
    {
      "target": { "name": "vector-store", "type": "vector-store" },
      "status": "UNREACHABLE",
      "latency_ms": null,
      "checks": { "reachability": { "status": "UNREACHABLE", "message": "connection refused" } },
      "dependencies": []
    }
  ]
}

The parent's own status is UNHEALTHY, not a literal copy of its UNREACHABLE dependency — see spec/health-model.md § Status Aggregation for why, and spec/result-schema.md for the full normative schema (including multi-target batch output).


Architecture

AgentHealth is designed around a small core and extensible adapters.

                         AgentHealth
                              │
                 Agent Health Specification
                              │
                       Health Engine
                              │
             ┌────────────────┼────────────────┐
             │                │                │
       Policy Engine    Dependency Engine   Output Engine
             │                │                │
             └────────────────┼────────────────┘
                              │
                       Adapter Interface
                              │
                              ├── Agent (direct / composite roles)
                              ├── HTTP / MCP / A2A
                              ├── Agentgateway / Agent Router integrations
                              └── Model / Tool / Data adapters

The Health Engine is designed to implement the Agent Health Specification. Its Go core engine now provides configuration loading, check execution, timeout/retry policies, result normalization, dependency evaluation, output formatting, and safety controls (see Phase 2 — Core Engine). The experimental AHP HTTP v1 binding exposes validated result snapshots through agenthealth serve.


Adapter Architecture

AgentHealth should not hard-code every vendor into its core.

Adapters provide technology-specific health logic.

Conceptually:

AgentHealth Core
      │
      ├── MCP Adapter
      ├── A2A Adapter
      ├── HTTP Adapter
      ├── Agent checks (direct / composite roles)
      ├── Agentgateway integrations
      ├── Agent Router integrations
      ├── Model Adapter
      ├── Database Adapter
      ├── Vector Store Adapter
      └── Community Adapters

The adapter interface should allow third parties to implement checks without modifying the core engine.

The planned Phase 23 — Plugin / Adapter Ecosystem includes extension examples for the first (direct) agent, downstream (composite) agents, Agentgateway, and Agent Router. Direct/composite describe agent roles, not separate target types or a requirement for separate adapters. The diagrams show intended coverage; Agent/multi-agent, HTTP/API, MCP, and A2A are the currently implemented adapters, together with the Phase 8 gateway and Phase 9 router adapters. Router integrations use the supported interfaces and contracts established in Phases 7–10.


Distribution

Standalone binaries and source builds are available; see installation. The container image is published to GHCR (with an optional Docker Hub mirror) starting in v0.10.0 (Phase 12); see container usage. SDK examples remain planned. Kubernetes source examples and chart 0.1.0 are implemented; the first chart was published separately as helm-v0.1.0; future releases follow the shared-version policy below.

Phase 13 package assets are included starting in v0.11.0: Homebrew/Scoop manifests and Linux DEB/RPM packages. Public taps, buckets and package repositories remain deferred. See package channels and the alignment audit.

Distribution versions

Starting with the next release, v0.12.0, all implemented artifacts use the same software version and source tag: CLI archives, Linux packages, Homebrew/Scoop manifests, Docker image, Helm chart and an additional OCI binary bundle. Helm uses version: 0.12.0, appVersion: v0.12.0 and a matching image. Future SDKs adopt that version when implemented; AHS/AHP contract versions remain separate. Existing CLI v0.11.1 and chart 0.1.0 remain historical releases.

Channel Contents Current availability
GitHub Releases Complete release page with binaries/packages, SBOMs, checksums, chart package, registry links and image digests CLI v0.11.1/chart 0.1.0 remain public; the unified v0.12.0 workflow is prepared in source
GitHub Packages: Docker GHCR multi-platform container image Available
GitHub Packages: Helm GHCR OCI chart, installable with Helm Implemented in source for v0.12.0; publication pending
GitHub Packages: binaries Additional OCI archive/package bundle, retrieved with an artifact client Implemented in source for v0.12.0; publication pending; ordinary downloads remain available

This replaces independent component versioning. OCI bundles do not create APT/YUM repositories or Homebrew/Scoop hosting. See the release policy and distribution plan for prerequisites, package identities, installation and verification requirements.

Standalone CLI

Pre-built binaries for:

Linux x86_64
Linux ARM64
macOS Apple Silicon
macOS Intel
Windows x86_64

Example:

agenthealth --version

Docker

AgentHealth can run without installing language runtimes. The image is a minimal, non-root distroless image for linux/amd64 and linux/arm64. Both registry references for v0.12.0:

# GitHub Container Registry
docker run --rm ghcr.io/theagenthealth/agenthealth:v0.12.0 version

# Docker Hub
docker run --rm theagenthealth/agenthealth:v0.12.0 version

Example:

docker run --rm ghcr.io/theagenthealth/agenthealth \
  ping mcp http://host.docker.internal:3000

See container usage for configuration files, credentials, and verification.


Python / PyPI

Python applications can integrate AgentHealth through an SDK.

pip install agenthealth

Conceptual usage:

from agenthealth import check

result = check(
    target_type="mcp",
    endpoint="http://localhost:3000"
)

print(result.status)

The Python package is an SDK/distribution mechanism.

AgentHealth itself is not a Python-specific standard.


JavaScript / TypeScript / npm

Node.js and TypeScript applications can integrate AgentHealth through an SDK.

npm install @agenthealth/sdk

Conceptual usage:

import { check } from "@agenthealth/sdk";

const result = await check({
  type: "mcp",
  endpoint: "http://localhost:3000"
});

console.log(result.status);

Kubernetes

AgentHealth is designed for cloud-native environments.

A traditional readiness probe may verify only that an HTTP endpoint responds.

AgentHealth can validate whether the workload's critical AI dependencies are actually ready.

Example:

readinessProbe:
  exec:
    command:
      - agenthealth
      - check
      - /etc/agenthealth/config.yaml

Implemented Kubernetes integrations include (see the guide and runnable examples):

  • readiness probes,
  • startup probes,
  • Jobs,
  • CronJobs,
  • init containers,
  • sidecars,
  • deployment validation,
  • admission/policy integrations in future releases.

CI/CD

AgentHealth can act as a deployment validation gate.

Example workflow:

Build
  │
  ↓
Deploy
  │
  ↓
AgentHealth
  │
  ├── Agent
  ├── A2A
  ├── MCP
  ├── Model
  ├── Tools
  └── Data
  │
  ↓
Promote / Rollback

Example:

agenthealth check production.yaml

if [ $? -ne 0 ]; then
  echo "Agentic system failed readiness validation"
  exit 1
fi

Exit-code semantics are defined in the specification.


Security Principles

Health tooling frequently interacts with credentials and production infrastructure.

AgentHealth should therefore follow several principles:

  • never print secrets,
  • redact authentication material,
  • avoid destructive checks,
  • use minimal privileges,
  • make active/functional probes explicit,
  • support configurable timeouts,
  • prevent accidental credential leakage in logs,
  • clearly distinguish passive and active checks,
  • provide secure defaults,
  • support TLS verification by default.

Adapters should document the permissions required for their checks.


Passive vs Active Checks

AgentHealth distinguishes between checks that inspect state and checks that execute functionality.

Passive

Examples:

Reach endpoint
Negotiate protocol
List capabilities
Read metadata
Measure connection latency

Active

Examples:

Invoke a tool
Run minimal model inference
Execute a database query
Send a test task to an agent

Active checks should be opt-in when they could create cost, side effects, or workload activity.


Observability Integration

AgentHealth itself is not an observability platform.

However, health results may eventually be exported to observability ecosystems through:

  • JSON,
  • OpenTelemetry,
  • Prometheus metrics,
  • structured logs,
  • webhooks,
  • CI/CD annotations.

This allows existing monitoring platforms to consume AgentHealth results.


Example Use Cases

Developer debugging
agenthealth doctor local-agent.yaml

Find why a local agent cannot function.

Platform engineering

Validate agent workloads before production deployment.

SRE

Determine which dependency is causing an agent to become degraded.

CI/CD

Prevent deployment promotion when critical agent dependencies are unavailable.

Kubernetes

Use agent-aware readiness instead of simple HTTP-only readiness.

MCP development

Validate that an MCP server initializes correctly and exposes expected capabilities.

Multi-agent systems

Check whether required peer agents are available and compatible.

Enterprise AI

Provide a consistent operational health interface across heterogeneous agent stacks.


Design Principles

AgentHealth follows these principles:

Universal

No dependency on one programming language, cloud, model provider, or agent framework.

Open

Specification and reference implementation developed openly.

Extensible

New protocols and technologies can be supported through adapters.

Safe

Health checks should be non-destructive by default.

Machine-readable

Every human-readable result should have a structured equivalent.

Cloud-native

Designed for containers, Kubernetes, CI/CD, and automation.

Composable

AgentHealth should complement existing platforms rather than replace them.

Interoperable

The same health vocabulary should work across heterogeneous agent infrastructure.


Repository Structure

AgentHealth is developed as a single repository (monorepo). The specification (AHS), the experimental protocol (AHP), the core engine, CLI, adapters, SDKs, and distribution integrations are not split across separate repos — they are maintained together here, with component versions governed by the release policy:

agenthealth/
│
├── README.md
├── ROADMAP.md
├── LICENSE
├── CONTRIBUTING.md
├── GOVERNANCE.md
├── SECURITY.md
├── CODE_OF_CONDUCT.md
│
├── spec/
│   ├── README.md
│   ├── health-model.md        # Agent Health Specification (AHS)
│   ├── protocol.md            # Agent Health Protocol (AHP) — experimental HTTP v1
│   ├── configuration.md
│   ├── result-schema.md
│   └── adapter-spec.md
│
├── cmd/
│   └── agenthealth/            # CLI entrypoint
│
├── core/                       # reference health engine
│
├── adapters/
│   ├── http/
│   ├── mcp/
│   ├── a2a/
│   ├── agent/
│   ├── gateway/
│   ├── router/
│   └── model/                    # planned
│
├── sdk/                       # planned
│   ├── python/                 # planned PyPI SDK
│   └── javascript/             # planned npm SDK
│
├── Dockerfile                  # released CLI container
├── deploy/
│   ├── kubernetes/              # manifests and Kustomize base
│   └── helm/agenthealth/        # independently published chart 0.1.0
│
├── integrations/               # future integrations
│   └── ci/                     # planned
│
├── examples/
│   └── kubernetes/              # runnable deployment scenarios
│
├── tests/
│   └── kubernetes/              # manifest, configuration and chart checks
│
└── docs/

This tree includes planned directories for future adapters, SDKs, and integrations. The exact repository structure may change as the implementation evolves, but the monorepo strategy itself is a settled decision (see Phase 0 — Project Foundation in the roadmap).


Run the CLI

Download a standalone binary from GitHub Releases; see installation instructions. Downloaded binaries do not require Go.

Build from source with Go 1.23 or newer:

go build -o agenthealth ./cmd/agenthealth
./agenthealth ping http https://example.com
./agenthealth check examples/core-check/agenthealth.yaml --format json
./agenthealth doctor examples/core-check/agenthealth.yaml
./agenthealth version

See CLI usage for formats, safety defaults, adapter availability, and exit codes.


Project Status

Early-stage / Pre-1.0

Coverage for phases 0–14 is indexed in the documentation guide.

AgentHealth is under active design and development. The Go engine, CLI, agent/multi-agent adapter, HTTP/API adapter, MCP HTTP/stdio adapter, A2A JSON-RPC adapter, gateway and router HTTP health adapters are implemented. A container image (Phase 12) is published to GHCR with an optional Docker Hub mirror. Kubernetes manifests and independently published Helm chart 0.1.0 are available (guide). Other adapters and SDKs remain roadmap work.

Interfaces, schemas, commands, and configuration formats may change before the 1.0 release.

Foundation stabilization is released in v0.4.0. v0.5.0 implements Phase 7 — Agent Health, covering direct and composite agents, liveness/readiness, bounded functional tasks, and separate agent, communication-path, and dependency evidence. Agentgateway integration is released in v0.6.0. Agent Router HTTP integration is released in v0.7.0. The dependency graph is released in v0.8.0. Experimental AHP serving is included in v0.9.0. The official container image is released in v0.10.0. SDKs and observability/conformance follow the roadmap. See the v0.5.0 release notes.


Roadmap

See ROADMAP.md for the detailed development roadmap.

High-level direction:

Specification
      ↓
Core Engine
      ↓
CLI
      ↓
HTTP + MCP + A2A
      ↓
Direct + Composite Agent Health (Phase 7)
      ↓
Agentgateway Integration (Phase 8)
      ↓
Agent Router Integration (Phase 9)
      ↓
Dependency Graph
      ↓
Agent Health Protocol (AHP)
      ↓
Docker
      ↓
Kubernetes
      ↓
Python SDK
      ↓
JavaScript/TypeScript SDK
      ↓
Model + Data Adapters
      ↓
Observability Integrations
      ↓
Community Adapter Ecosystem
      ↓
Conformance + Ecosystem Interoperability Testing

Governance

AgentHealth is intended to evolve as a community-driven open-source project.

The long-term objective is neutral, transparent governance suitable for broad ecosystem collaboration.

The project welcomes participation from:

  • AI agent developers,
  • MCP developers,
  • A2A developers,
  • platform engineers,
  • SREs,
  • DevOps engineers,
  • AI infrastructure engineers,
  • cloud-native developers,
  • framework maintainers,
  • model providers,
  • enterprises,
  • researchers,
  • standards communities.

Contributing

Contributions are welcome.

Useful contribution areas include:

  • core implementation,
  • protocol adapters,
  • provider adapters,
  • SDKs,
  • Kubernetes integrations,
  • CI/CD integrations,
  • specification design,
  • interoperability testing,
  • direct/composite agent, Agentgateway, and Agent Router health integrations,
  • conformance and communication-path failure testing,
  • documentation,
  • examples,
  • security reviews,
  • testing.

Please see CONTRIBUTING.md.


Community Adapter Ideas

Potential future adapters include:

Agent checks (direct / composite roles)
Agentgateway integrations
Agent Router integrations

MCP
A2A
OpenAI-compatible APIs
Anthropic
Amazon Bedrock
Azure AI
Google Vertex AI
Ollama

PostgreSQL
MySQL
MongoDB
Redis

Pinecone
Qdrant
Weaviate
Milvus
pgvector
OpenSearch
Elasticsearch

LangGraph
Semantic Kernel
CrewAI
AutoGen
and other agent runtimes

Listing a technology here does not imply endorsement, partnership, or current support.


Interoperability Vision

The long-term goal is bigger than a CLI.

Planned Phase 24 — AgentHealth Conformance will validate the health of the first (direct) agent, downstream (composite) agents, Agentgateway, Agent Router, and their communication paths against the approved AHS and AHP contracts. Supporting dependency results remain distinct.

Phase 25 — Ecosystem Interoperability Testing will test first-to-downstream communication directly, through A2A, and through gateways or routers across supported stacks. Scenarios include a healthy downstream agent behind a failing path, a failing agent behind a healthy gateway/router, shared backends, and multiple routes. No conformance program or certification is currently available.

AgentHealth aims to establish a common operational contract for agentic systems:

How do I determine whether an agent is healthy?

How does an agent expose readiness?

Can my first agent communicate with its downstream agents,
directly or through A2A, Agentgateway, or an Agent Router?

How do I represent dependency health?

How do I distinguish degraded from unhealthy?

How do platforms consume health consistently?

How can health work across MCP, A2A, models,
tools, databases, runtimes, and vendors?

A common health specification allows different implementations to answer those questions consistently.


Long-Term Vision

AgentHealth aims to become a simple, universal operational primitive for agentic infrastructure.

The planned ecosystem covers the user's first (direct) agent, the downstream (composite) agents it communicates with directly or via A2A, Agentgateway, Agent Router, and supporting model, tool, MCP, and data dependencies. The common health contract should distinguish each agent's health from gateway, router, and communication-path health. This follows the roadmap ecosystem vision; direct/composite are agent roles, and implementation availability follows the phase statuses.

Just as developers commonly use:

ping
curl
health endpoints
readiness probes

for conventional distributed systems, the goal is for agent developers and operators to be able to use:

agenthealth ping
agenthealth check
agenthealth doctor

across the agentic AI ecosystem.


License

AgentHealth is released under the Apache License 2.0.

The Apache-2.0 license was chosen for its explicit patent grant, which fits a project whose long-term ambition includes contribution toward broader interoperability standards (see Interoperability Vision).


Disclaimer

AgentHealth is an independent open-source project.

References to third-party projects, protocols, companies, products, or trademarks are for interoperability and descriptive purposes only and do not imply affiliation, sponsorship, or endorsement.

Phase 8 Agentgateway integration is released in v0.6.0. See the gateway guide. Gateway checks use explicitly configured read-only HTTP signals and separate backend/path dependencies.

Experimental AHP serving

agenthealth serve <configuration.yaml> exposes snapshot health over HTTP. See the AHP guide for authorization, freshness and deployment.

Directories

Path Synopsis
adapters
a2a
Package a2a implements bounded A2A 1.0 and 0.3.0 JSON-RPC health validation.
Package a2a implements bounded A2A 1.0 and 0.3.0 JSON-RPC health validation.
agent
Package agent implements a framework-neutral, bounded agent health interface.
Package agent implements a framework-neutral, bounded agent health interface.
gateway
Package gateway implements read-only Agentgateway HTTP health signals.
Package gateway implements read-only Agentgateway HTTP health signals.
http
Package http implements passive HTTP readiness and opt-in response matching.
Package http implements passive HTTP readiness and opt-in response matching.
mcp
Package mcp implements bounded, session-isolated Streamable HTTP health checks.
Package mcp implements bounded, session-isolated Streamable HTTP health checks.
router
Package router implements read-only HTTP health signals for agent routers.
Package router implements read-only HTTP health signals for agent routers.
cmd
agenthealth command
Package core implements the shared Agent Health Specification model.
Package core implements the shared Agent Health Specification model.
examples
core-check command
This example exercises Phase 2 without implementing the Phase 3 CLI.
This example exercises Phase 2 without implementing the Phase 3 CLI.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL