m4trixm4trixDocs
AgentsEvalsTracing

Getting Started

  • What is m4trix?
  • Install
  • Hello World
  • Run + Expected Output
  • What's Happening (Mental Model)
  • How to ...
  • Next Steps

Concepts

  • Events (Type System + Schema)
  • Channels
  • Agents (Logic + Lifecycle)
  • Networks (Wiring)
  • Context
  • Streaming, Proxies & Adapters
  • Package Structure

Guides

  • Patterns: Request/Response, Fan-Out, Join, Retries
  • Streaming: SSE/WebSocket, Backpressure, Chunking
  • AuthN/Z + Multi-Tenant Isolation
  • Error Handling + Observability Hooks
  • Testing (Unit + Integration + Replay)
  • Deployment (Next.js, Express, Edge)
  • Next.js
  • Express

API Reference

  • AgentFactory
  • AgentNetwork
  • AgentNetworkEvent
  • Channel API
  • IO + Adapters (NextEndpoint, Express, etc.)
  • Types / Advanced Generics

Examples

  • Minimal Starter
  • Multi-Agent Workflow
  • RAG + Tools
  • Eval Harness
  • Common Recipes

Project

  • Versioning + Stability
  • Changelog
  • Migration Guides
  • FAQ / Troubleshooting
  • Security Considerations
  • Contributing

Getting Started

Next Steps

After completing the 10-minute quick start, explore these paths:

Understand the Concepts

Events

Learn how typed messages move through the system.

Channels

Understand routing, proxies, and event delivery.

Agents

Build units of logic with lifecycle and type inference.

Networks

Wire agents and channels into a running event plane.

Build Real Things

Patterns

Request/response, fan-out, join, and retry patterns.

Streaming

SSE, backpressure, and chunking guidance.

Next.js

Expose networks through Next.js App Router routes.

Express

Expose networks through an Express route.

API Reference

AgentFactory

Builder API for type-safe agents.

AgentNetwork

Orchestration, setup, and runtime wiring.

IO + Adapters

NextEndpoint, ExpressEndpoint, and streaming adapters.

Examples

Minimal Starter

Start from the smallest working setup.

Multi-Agent Workflow

Chain agents into a larger workflow.

Evals

Build repeatable evaluation suites with @m4trix/evals.

Tracing

Record and inspect LangGraph or LangChain-style traces.

Edit this page on GitHubView as Markdown
PreviousHow to ...NextEvents (Type System + Schema)

On this page

  • Understand the Concepts
  • Build Real Things
  • API Reference
  • Examples