Skip to main content

SDK for building hosted multi-agent Mash applications.

Project description

mashpy

This repository is the development workspace for Mash.

It contains three main components:

  • mash.runtime The managed runtime for an agent.
  • mash.api The self-hosted API server in src/mash/api.
  • mash.cli The bundled CLI in src/mash/cli.

Repo layout

src/mash/                  SDK, host API, and CLI
docs/rfcs/                 Protocol and design RFCs
pilot/                     Mash Pilot host built on Mash
tests/                     Unified test suite
Dockerfile                 Base image for Mash host deployments

RFCs

Mental model

The architecture is:

  • app developers use mashpy to define one or more AgentSpecs
  • an app exposes build_host() -> MashAgentHost
  • mash.api loads that host and serves HTTP
  • mash.api also serves the built-in telemetry UI at /telemetry
  • mash talks to a running Mash API deployment
  • deployments are expected to run in a container

Mash stores agent state under:

  • <MASH_DATA_DIR>/<agent_id>/state.db

state.db is the single per-agent SQLite store. It contains:

  • conversation turns and signals
  • preferences and app data
  • structured runtime logs in the logs table

If MASH_DATA_DIR is not set, the runtime falls back to /var/lib/mash.

Local setup

Create the repo virtualenv, install dependencies, and activate it:

uv venv
uv sync
source .venv/bin/activate

System Architecture

At a high level, mashpy is one distribution with three cooperating surfaces:

  • mash.core The agent loop itself: config, context, provider adapters, and think/act/observe execution.
  • mash.runtime Host-side orchestration: AgentSpec, runtime servers, host/client wiring, request streaming, session storage, and subagent delegation.
  • mash.api and mash.cli App facing surfaces built on top of the runtime. mash.api exposes the FastAPI host service and telemetry UI; mash.cli is the remote client.

The normal execution path is:

  1. An app defines one or more AgentSpecs.
  2. MashAgentHostBuilder composes those specs into a MashAgentHost.
  3. mash.api starts the host and exposes HTTP endpoints for agent requests, sessions, history, and telemetry.
  4. mash.cli talks to that HTTP API as a remote client.
flowchart TD
    A["`AgentSpec`"] --> B["`MashAgentHostBuilder`"]
    B --> C["`MashAgentHost`"]
    C --> D["`mash.api`"]
    G["`mash.cli`"] --> D
    D --> F["MashAgent"]

Persistence is runtime-level, not app-level. Each agent stores state under:

  • <MASH_DATA_DIR>/<agent_id>/state.db

Structured runtime events are stored inside that SQLite database in the logs table rather than in a separate JSONL file.

If MASH_DATA_DIR is not set, the runtime falls back to /var/lib/mash.

Agent Runtime

The core execution stack is:

  • src/mash/runtime/spec.py AgentSpec is the transport-agnostic contract app authors implement.
  • src/mash/runtime/host.py MashAgentHost and MashAgentHostBuilder register the primary agent and subagents, start one in-process uvicorn-backed runtime server per agent, and wire host-managed delegation.
  • src/mash/runtime/runtime.py MashAgentRuntime is the async execution core for one agent: request lifecycle, per-session serialization, persistence, and trace fanout.
  • src/mash/runtime/server.py MashAgentServer is the Starlette transport adapter over one runtime and exposes the H2A HTTP + SSE surface.
  • src/mash/core/agent.py Agent.run() executes the think/act/observe loop and emits trace + token metadata.
  • src/mash/runtime/client.py MashAgentClient is the async H2A client used by the host and by subagent delegation.
sequenceDiagram
    participant User
    participant API as mash.api
    participant Host as MashAgentHost
    participant Client as MashAgentClient
    participant Server as MashAgentServer
    participant Runtime as MashAgentRuntime
    participant Agent as mash.core.Agent
    participant Store as State Store

    User->>API: POST /api/v1/agent/{agent_id}/request
    API->>Host: get_client(agent_id)
    Host-->>API: MashAgentClient
    API->>Client: post_request(...) / stream_response(...)
    Client->>Server: HTTP request + SSE stream
    Server->>Runtime: submit_request(...) / stream_request_events(...)
    Runtime->>Agent: process_user_message(...)
    Agent->>Agent: think -> act -> observe
    Agent-->>Runtime: Response + token_usage + trace_id
    Runtime->>Store: save_turn(...)
    Runtime->>Store: collect_signals(...)
    Server-->>Client: request.accepted / request.waiting? / agent.trace / request.completed
    Client-->>API: streamed runtime events
    API-->>User: SSE / final payload

Important runtime properties:

  • Each request is accepted immediately and runs in its own async task.
  • Requests for the same session_id are serialized inside one runtime with a per-session lock.
  • Different sessions on the same agent may run concurrently up to the runtime concurrency limit.
  • Request lifecycle is streamed over SSE using stable event names: request.accepted, optional request.waiting, request.started, agent.trace, request.completed, request.error.
  • Token accounting is session-scoped inside each runtime. session_total_tokens is computed from saved turn metadata and persisted with each turn.
  • Runtime logs are persisted in each agent's MemoryStore and also fanned out as live events for telemetry and remote clients.
  • The runtime H2A surface is: GET /health, POST /agent/{agent_id}/request, GET /agent/{agent_id}/request/{request_id}.

Working on the SDK

The main SDK surface is:

The intended app shape is:

from mash.core.config import AgentConfig
from mash.core.llm import AnthropicProvider
from mash.runtime import AgentSpec, MashAgentHostBuilder
from mash.skills.registry import SkillRegistry
from mash.tools.registry import ToolRegistry


class PrimaryAgent(AgentSpec):
    def get_agent_id(self) -> str:
        return "primary"

    def build_tools(self) -> ToolRegistry:
        return ToolRegistry()

    def build_skills(self) -> SkillRegistry:
        return SkillRegistry()

    def build_llm(self):
        return AnthropicProvider(app_id="primary", api_key="...")

    def build_agent_config(self) -> AgentConfig:
        return AgentConfig(app_id="primary", system_prompt="You are helpful.")


def build_host():
    return MashAgentHostBuilder().primary(PrimaryAgent()).build()

Subagent Invocation Flow

Subagent delegation is host-managed, not a special local shortcut.

  1. The host registers the primary agent and subagents in src/mash/runtime/host.py.
  2. On startup, the host resolves subagent endpoints and the primary runtime injects subagent routing guidance plus InvokeSubagent.
  3. InvokeSubagentTool in src/mash/tools/subagent.py resolves the target subagent client and submits a normal streamed request.
  4. The subagent request runs through that subagent’s own runtime server, runtime core, persistence layer, and session namespace.
  5. Streamed request events are forwarded back to the primary runtime as subagent.* trace events for observability.
sequenceDiagram
    participant Primary as Primary Agent
    participant Tool as InvokeSubagentTool
    participant Host as MashAgentHost
    participant Client as MashAgentClient
    participant Server as Subagent MashAgentServer
    participant Runtime as Subagent MashAgentRuntime
    participant Subagent as Subagent mash.core.Agent

    Primary->>Tool: InvokeSubagent(agent_id, prompt, opts)
    Tool->>Host: get_client(agent_id)
    Host-->>Tool: MashAgentClient
    Tool->>Client: post_request(prompt, session_id=subagent_session_id)
    Client->>Server: HTTP request + SSE stream
    Server->>Runtime: submit_request(...) / stream_request_events(...)
    Runtime->>Subagent: process_user_message(...)
    Subagent->>Subagent: think -> act -> observe
    Subagent-->>Runtime: Response + token_usage + trace_id
    Server-->>Client: request.accepted / agent.trace / request.completed
    Client-->>Tool: streamed events
    Tool-->>Primary: ToolResult(text + metadata)

Relevant implementation details:

  • Subagent session ids are deterministic via src/mash/runtime/session.py using: primary_app_id + primary_session_id + subagent_id.
  • The subagent keeps its own session history and token totals.
  • The primary agent only owns its own turns and token usage; subagent execution is correlated, but not merged into the primary session’s token total.

Core Modules

When working on mashpy, these are the main files to orient around:

Common contributor questions:

  • If you are changing request or event shapes, update runtime tests, API tests, and CLI streaming behavior together.
  • If you are changing token accounting or persistence, validate both tests/mash/runtime/test_engine.py and tests/mash/runtime/test_host_integration.py.
  • If you are changing telemetry behavior, remember there are two layers: the API routes in mash.api, and the bundled frontend assets under src/mash/api/web.

Mash Pilot

pilot/spec.py is the main in-repo agent app built on Mash.

Pilot uses standard Mash building blocks:

  • PilotSpec is the primary AgentSpec.
  • build_host() composes the primary pilot plus module-specific copilots with MashAgentHostBuilder.
  • mash.api serves that host over HTTP.
  • mash.cli connects to it as a remote client.

The Pilot host currently registers:

  • pilot: the primary codebase guide for shared Mash modules.
  • cli-copilot: specialist for src/mash/cli.
  • api-copilot: specialist for src/mash/api.
  • mcp-copilot: specialist for src/mash/mcp.

Run Pilot from the activated repo environment:

export OPENAI_API_KEY=...
export MASH_DATA_DIR=.mash

python -m pilot.spec \
  --workspace-root /Users/sid/Projects/mashpy \
  --host 127.0.0.1 \
  --port 8000 \
  --api-key secret

Connect with the bundled CLI:

mash connect --api-base-url http://127.0.0.1:8000 --api-key secret --agent pilot
mash status
mash agents
mash repl

Open the built-in telemetry UI:

Pilot is useful as both:

  • a real Mash app built on the same AgentSpec and MashAgentHostBuilder contracts exposed to users
  • the canonical reference for how to build a multi-agent Mash host with specialized subagents

Masher

Masher is another agent built on Mash, implemented in src/mash/agents/masher/spec.py.

It is a built-in log-analysis specialist that uses the normal Mash runtime contracts:

  • MasherAgentSpec is a regular AgentSpec.
  • it uses Mash memory/store tools to resolve recent sessions and traces
  • it reads structured event rows from the target agent's MemoryStore
  • it can append normalized online-eval rows with append_jsonl

Pilot enables Masher by default with .enable_masher(), but Masher can also be registered in any other Mash host that wants a log-analysis subagent.

Running the host API directly

You can start the API server either from Python or through mash host serve.

From Python:

from mash.api import MashHostConfig, run_host

from my_app import build_host

run_host(build_host(), config=MashHostConfig(bind_host="0.0.0.0", bind_port=8000))

From the CLI:

MASH_HOST_APP=my_app:build_host \
MASH_API_HOST=0.0.0.0 \
MASH_API_PORT=8000 \
MASH_DATA_DIR=/var/lib/mash \
mash host serve

For containerized deployments, the env-driven startup path is the intended one.

Docker workflow

The root Dockerfile is the base image for Mash host deployments.

Build it:

docker build -t mashpy/mash-host-base:latest .

The Pilot image is defined in pilot/Dockerfile.

Build and run it:

docker build -t mashpy/pilot:latest -f pilot/Dockerfile .
docker run \
  -p 8000:8000 \
  -e OPENAI_API_KEY=... \
  -e MASH_HOST_APP=pilot.spec:build_host \
  -e MASH_API_KEY=secret \
  -e MASH_DATA_DIR=/var/lib/mash \
  -v $(pwd)/data:/var/lib/mash \
  mashpy/pilot:latest

The container contract is:

  • MASH_HOST_APP points at module:build_host
  • MASH_DATA_DIR points at the persistent state root
  • port 8000 is exposed by default
  • operators mount persistent storage at /var/lib/mash

Tests

Focused runtime and API tests:

PYTHONPATH=src \
pytest -q \
  tests/mash/runtime/test_engine.py \
  tests/mash/runtime/test_host_integration.py \
  tests/mash/api/test_host_server.py

CLI-focused tests:

PYTHONPATH=src \
pytest -q \
  tests/mash/cli/test_main.py \
  tests/mash/cli/test_shell.py

When changing cross-surface behavior, set PYTHONPATH=src so tests resolve the unified workspace sources instead of stale installed copies.

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

mashpy-0.2.4.tar.gz (162.9 kB view details)

Uploaded Source

Built Distribution

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

mashpy-0.2.4-py3-none-any.whl (186.8 kB view details)

Uploaded Python 3

File details

Details for the file mashpy-0.2.4.tar.gz.

File metadata

  • Download URL: mashpy-0.2.4.tar.gz
  • Upload date:
  • Size: 162.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for mashpy-0.2.4.tar.gz
Algorithm Hash digest
SHA256 9e77bb70f7c1d0ebe8a7e1b69edc18207c403c16e522eb0301add5e14f9565f4
MD5 cb11ed36a8c26639f9ce7c10cce695fd
BLAKE2b-256 e234410a84aadcc114fb8b7d46dd4775a5cc40d7eaca972f6a72d61871bbfca4

See more details on using hashes here.

Provenance

The following attestation bundles were made for mashpy-0.2.4.tar.gz:

Publisher: publish.yml on imsid/mashpy

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file mashpy-0.2.4-py3-none-any.whl.

File metadata

  • Download URL: mashpy-0.2.4-py3-none-any.whl
  • Upload date:
  • Size: 186.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for mashpy-0.2.4-py3-none-any.whl
Algorithm Hash digest
SHA256 605574405481b9e733b69de6afbb004643dc05cb779c9d02c95594d422c97725
MD5 09c48d5b2e6d742cff4d36accf3c1106
BLAKE2b-256 851e3a6f7506c09d3796787b370b79fd0e9ccf1a2263e0b2f12e7df9ffc1c222

See more details on using hashes here.

Provenance

The following attestation bundles were made for mashpy-0.2.4-py3-none-any.whl:

Publisher: publish.yml on imsid/mashpy

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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