Skip to main content

kurrent-agent-schema

Canonical event schema types for Kurrent agent integrations — schema version 2.

This package is the Python mirror of the canonical agent event schema shared across Kurrent's agent-framework integrations (Google ADK, Microsoft Agent Framework, Strands, OpenAI Agents, Claude Agent SDK) and Capacitor. The prose specification lives in schema/SCHEMA_v2.md; the .NET mirror is Kurrent.Agent.Schema.

Wire format

Backed by Protobuf codegen from schema/proto/. The JSON wire format follows the proto3 canonical mapping with preserve_proto_field_name (snake_case on the wire). The sanctioned JSON entry points are to_json(event) and from_json(cls, src) — direct calls to google.protobuf.json_format are not supported.

What's here

  • Canonical event models (generated Protobuf message classes): SessionStarted, SessionEnded, SessionContinuedAs, UserMessageReceived, AssistantTextGenerated, AssistantToolCallsGenerated, AssistantThinkingGenerated, ToolResultReceived, InterruptIssued, InterruptResolved, SubagentStarted, SubagentCompleted, FactRetained, ArtifactVersionCreated, EvalRunStarted, TurnScored, EvalRunCompleted.
  • Value types: AgentConfig, ToolSpec, ToolCallInfo.
  • Usage metadata: TokenUsage (carried on KurrentDB event metadata under the $usage key, not as a standalone event).
  • Stream-name builders: agent_session_stream, agent_subsession_stream, agent_memory_stream, agent_artifact_stream, eval_run_stream.
  • Type-name registry: EVENT_TYPE_NAMES / EVENT_TYPE_BY_NAME for wiring up KurrentDB event-type to/from CLR-type conversion.

What's not here

  • Framework-specific events and extension shapes. ADK's AgentTransferred/Rewind, AFW's workflow checkpoints, Capacitor's AgentRunStarted/visibility events, coding-agent fields under extensions.claude_code.*, etc. Those live in their owning integration packages — this package deliberately carries only the portable vocabulary.

Usage

from datetime import datetime, timezone
from kurrent_agent_schema import (
    SessionStarted, UserMessageReceived, AssistantTextGenerated,
    TokenUsage, USAGE_METADATA_KEY, agent_session_stream,
)

stream = agent_session_stream("sess-0001")  # "AgentSession-sess-0001"

event = UserMessageReceived(
    content="hello",
    message_index=0,
    timestamp=datetime.now(tz=timezone.utc),
    extensions={"adk": {"invocation_id": "inv_abc"}},
)

# $usage goes on KurrentDB metadata, not the payload
usage = TokenUsage(input_tokens=1507, output_tokens=203, model="claude-sonnet-4-6")

Drift guard

Every canonical event has a JSON fixture under schema/fixtures/events/. The test suite here runs a round-trip assertion per fixture; an equivalent suite in the .NET package runs against the same fixtures. Adding or modifying a canonical field requires a coordinated PR: update the model and the fixture, in both Python and .NET packages. CI fails otherwise.

cd schema/python
uv pip install -e ".[dev]"
pytest

Version

  • Package: 0.5.0 (Protobuf-generated source; see CHANGELOG.md for breaking changes).
  • Schema: SCHEMA_VERSION = 2, stamped on KurrentDB metadata under $schema_version by integration writers.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

kurrent_agent_schema-0.5.0.tar.gz (20.7 kB view details)

Uploaded Source

Built Distribution

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

kurrent_agent_schema-0.5.0-py3-none-any.whl (17.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: kurrent_agent_schema-0.5.0.tar.gz
  • Upload date:
  • Size: 20.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for kurrent_agent_schema-0.5.0.tar.gz
Algorithm Hash digest
SHA256 a58d644151f3e66633102c569fdd76cb34d6e9a93de67ca66df61c8847499c48
MD5 4d8bc08f7c9998551e48557b091b08f0
BLAKE2b-256 1bda88972bb9a1b9b242c47c5ed08c5f6428c2ac4432ec0730190a7eaa00ac36

See more details on using hashes here.

Provenance

The following attestation bundles were made for kurrent_agent_schema-0.5.0.tar.gz:

Publisher: schema-publish-pypi.yml on kurrent-io/kurrent-agents

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

File details

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

File metadata

File hashes

Hashes for kurrent_agent_schema-0.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 8e8f66950edd7fcb201a35a18a3b31f57630ed5ffd3024e92ecc20779b7f1f4f
MD5 d07aec498f537863b2a300649438a962
BLAKE2b-256 5acb963df41a672cb33ce7a0af64188490bf2983e6322a05b877bc18ac42f223

See more details on using hashes here.

Provenance

The following attestation bundles were made for kurrent_agent_schema-0.5.0-py3-none-any.whl:

Publisher: schema-publish-pypi.yml on kurrent-io/kurrent-agents

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

Release history Release notifications | RSS feed

This release

0.5.0 This release

2 files

0.4.0

2 files

0.3.1

2 files

0.3.0

2 files

0.2.1

2 files

0.2.0

2 files

0.1.2

2 files

0.1.1

2 files

0.1.0

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page