Skip to content

StatePlane

StatePlane architecture overview

StatePlane is a typed context compiler plus provider request preparation layer.

Current supported product surfaces:

  • stateplane Python SDK for embedding in customer code
  • stateplane installable CLI for local compile, render, debug, and demo workflows
  • lower-level packages such as context_core and provider_openai

Start Here If You Are New

If you are new to the project, start with Getting Started.

That page shows one complete flow:

  1. create StatePlaneSession(...)
  2. call transform(...) with messages = [...]
  3. inspect selected and excluded context
  4. inspect the final provider payload
  5. optionally execute the provider call

What It Does Today

StatePlane currently helps you decide what context should go into one provider request, explain why that context was chosen, and render the exact payload that would be sent.

What goes in:

  • a task summary
  • a transcript or bucketed context inputs
  • provider and model identifiers
  • a token budget and response reserve

What changes:

  • inputs are normalized into typed context items
  • required items are preserved
  • optional items are selected or excluded deterministically
  • a typed report explains the decision
  • the selected items become one provider-specific payload

What comes out:

  • prepared.request
  • prepared.compiled_context
  • prepared.compilation_report
  • prepared.rendered_request

Choose one path based on your goal:

SDK Versus CLI

The SDK is the main product surface. The CLI wraps the same SDK operations for:

  • local inspection
  • reproducible demos
  • CI checks
  • support and debugging

Start here: