Skip to main content

Quartermaster — modular AI agent orchestration framework. Install this to get all packages.

Project description

Quartermaster SDK

Modular AI agent orchestration framework by MindMade.

Quartermaster lets you build AI agent workflows as directed graphs — define nodes (LLM calls, decisions, user input, tools), connect them with edges, and execute them with a pluggable engine.

What's new in v0.5.0

  • Simplified Ollama provider -- OllamaProvider is now a thin subclass of the OpenAI-compatible client; the separate OllamaNativeProvider, the sync chat() shim, and the ollama_tool_protocol knob are gone. One transport for every local and cloud OpenAI-compatible endpoint.
  • Parallel tool execution -- when a model emits multiple tool_calls in a single turn, the agent loop dispatches them concurrently; wall-clock drops from O(sum(t)) to O(max(t)).
  • program_runner(program=<callable>) -- pass a @tool()-decorated function directly instead of its name string; the graph builder auto-registers it. Parity with .agent(tools=[...]).
  • Universal tool-name prefix strip -- default_api:foo, default_api.foo, functions:foo, mcp:foo all resolve via rsplit on : or ..
  • duckduckgo_search UA fix -- realistic Chrome UA + Accept/Referer headers.

What shipped in v0.4.0

  • Application timeouts -- qm.configure(timeout=, connect_timeout=, read_timeout=) + per-call overrides.
  • Stream cancellation -- with qm.run.stream(...) as stream: context-manager; qm.Cancelled + ctx.cancelled.
  • Per-node tool scoping -- agent(tools=[...]) strictly enforced; tool_scope="permissive" escape hatch.
  • Inline @tool callables -- agent(tools=[my_func]) accepts bare callables.
  • instruction_form -- Gemma preamble robustness + dict-schema support.
  • qm.configure(telemetry=True) -- sugar for qm.telemetry.instrument().
  • qm.configure(auto_redact_pii=True) -- automatic PII redaction policy.
  • Trace.from_jsonl() / assert_traces_equal() -- round-trip trace serialisation for golden-file tests.
  • SessionStore protocol -- qm.run(graph, input, session=store, session_id=...) + InMemorySessionStore.
  • TypedEvent -- Pydantic base class for typed custom events.
  • python -m quartermaster_sdk.lint check -- static graph linter (QM001--QM005).
  • CircuitBreaker -- CircuitBreaker(failure_threshold=, recovery_timeout=) + CircuitOpenError.
  • Local-GPU cost tracker -- duration_seconds + local_gpu_cost_per_hour support.

Quick Install

# Core framework (graph + providers + tools + nodes + engine)
pip install quartermaster-sdk

# With OpenAI
pip install quartermaster-sdk[openai]

# With everything (all providers, all tools, MCP client, code runner)
pip install quartermaster-sdk[all]

Quick Start (local Ollama, zero config)

ollama pull gemma4:26b      # or any model you've pulled
import quartermaster_sdk as qm

qm.configure(
    provider="ollama",
    base_url="http://localhost:11434",   # or set $OLLAMA_HOST
    default_model="gemma4:26b",
)

# Graph() auto-creates Start; .end() / .build() are both optional when running via qm.run().
result = qm.run(qm.Graph("chat").user().agent(), "Pozdravljen, koliko je ura?")
print(result.text)

Single-shot helpers (no graph visible)

# prompt → str
reply = qm.instruction(system="Respond in Slovenian.", user="Pozdravljen!")

# prompt → Pydantic model (typed JSON extraction)
from pydantic import BaseModel

class Classification(BaseModel):
    category: str
    priority: str

data = qm.instruction_form(Classification, system="Classify.", user=email_body)

Reading specific node outputs with capture_as=

graph = (
    qm.Graph("enrich")
    .agent("Research", tools=[...], capture_as="notes")
    .instruction_form(CustomerData, system="Extract.", capture_as="data")
)
result = qm.run(graph, "VT-Treyd Slovenija")
result["notes"].output_text    # agent's free-text research
result["data"].output_text     # extracted JSON

Streaming (v0.3.0 filtered iterators)

qm.run.stream(...) returns a wrapper you can iterate raw or pipe through a filter — one helper per chunk family:

Filter Yields Use for
.tokens() str (the token text) Typewriter UI — just the text
.tool_calls() ToolCallChunk Dashboard cards: call.tool, call.args
.progress() ProgressChunk prog.message, prog.percent, prog.data
.custom(name=...) CustomChunk Application-defined milestones
(raw for chunk in ...) Chunk union Debugging, pass-through consumers
# Typewriter effect -- tokens only.
for token in qm.run.stream(graph, "Tell me a story").tokens():
    print(token, end="", flush=True)

# Dashboard view -- just the tool calls.
for call in qm.run.stream(graph, "Research Slovenia").tool_calls():
    ui.tool_card(call.tool, call.args)

# Progress cards interleaved with model tokens.
for prog in qm.run.stream(graph, "Crunch the dataset").progress():
    ui.status(prog.message, prog.percent)

# Subscribe to one milestone name only.
for evt in qm.run.stream(graph, "Research").custom(name="source_found"):
    ui.add_source(evt.payload["url"])

Streams are single-pass — the wrapper owns its underlying generator, so picking a second filter (or raw-iterating after a filter) raises RuntimeError("stream already consumed"). Pick one consumer per stream.

The async analogue is available via qm.arun.stream(...) with the same four filter helpers, returning AsyncIterator[...].

Post-mortem Result.trace

Every Result (sync or the terminal DoneChunk.result of a stream) carries a structured Trace built from the full FlowEvent stream:

result = qm.run(graph, "Hello!")

result.trace.text                        # concatenated model output
result.trace.tool_calls                  # list[dict] across every agent node
result.trace.progress                    # list[ProgressEvent]
result.trace.custom(name="source_found") # filtered CustomEvent list
result.trace.by_node["Researcher"].text  # tokens for a single node
print(result.trace.as_jsonl())           # JSONL export for logs / fixtures

Progress events from inside tools

Long-running tools reach the flow's ExecutionContext via qm.current_context() and emit structured events that stream back to the UI alongside model tokens:

from quartermaster_tools import tool

@tool()
def slow_research(topic: str) -> dict:
    ctx = qm.current_context()      # None when called outside a flow -- safe
    if ctx is not None:
        ctx.emit_progress("Gathering sources", percent=0.25, topic=topic)
        ctx.emit_custom("source_found", {"url": "https://example.com"})
    # ... do real work ...
    return {"summary": "..."}

OpenTelemetry instrumentation

pip install 'quartermaster-sdk[telemetry]'
from quartermaster_sdk import telemetry

telemetry.instrument()     # uses the global tracer provider
qm.run(graph, "Hello!")    # every node + tool call is now a span

Spans follow the OpenTelemetry GenAI semantic conventions (gen_ai.system, gen_ai.operation.name, gen_ai.tool.name, gen_ai.usage.input_tokens, …). Point your exporter at Jaeger, Tempo, Honeycomb, Logfire, Phoenix, or any OTLP collector.

Quick Start (cloud provider)

agent = (
    qm.Graph("My Agent")
    .user("What can I help you with?")
    .instruction("Respond", model="gpt-4o", system_instruction="You are a helpful assistant.")
)
result = qm.run(agent, "How does photosynthesis work?")

Packages

Package Description
quartermaster-graph Graph schema, builder API, validation
quartermaster-providers LLM provider abstraction (OpenAI, Anthropic, Google, Groq, local)
quartermaster-tools Tool definition, registry, built-in tools
quartermaster-nodes Node execution protocols and implementations
quartermaster-engine Flow execution, traversal, memory, streaming
quartermaster-mcp-client MCP protocol client (standalone)
quartermaster-code-runner Docker sandboxed code execution (standalone)

Documentation

See the docs/ directory:

License

Apache 2.0

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

quartermaster_sdk-0.5.0.tar.gz (98.6 kB view details)

Uploaded Source

Built Distribution

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

quartermaster_sdk-0.5.0-py3-none-any.whl (69.9 kB view details)

Uploaded Python 3

File details

Details for the file quartermaster_sdk-0.5.0.tar.gz.

File metadata

  • Download URL: quartermaster_sdk-0.5.0.tar.gz
  • Upload date:
  • Size: 98.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.15

File hashes

Hashes for quartermaster_sdk-0.5.0.tar.gz
Algorithm Hash digest
SHA256 c13441ac9f98740bae6434a4d702612084af1083b85b2a7b51d04eb39dbbe975
MD5 2627d4d775dc40bf63c75e7690a6753d
BLAKE2b-256 44320d6ec2e6b87ef8931b593283a3372df8a68ddda3237d15fd14758e636779

See more details on using hashes here.

File details

Details for the file quartermaster_sdk-0.5.0-py3-none-any.whl.

File metadata

File hashes

Hashes for quartermaster_sdk-0.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 8a6ccbc55b3934b9a491d758d26fb8d9af2b45526ddca01b322524130e429b15
MD5 043a40f4268d32cbf51de068418d0fa8
BLAKE2b-256 6008a36f1db66b57b186820765181fcc0b4b073ac45920de90309e210a1e0aa2

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