Skip to main content

Canonical event schema for Kurrent agent integrations (schema v2)

Project description

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.

What's here

  • Canonical event models (Pydantic v2): 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.1.1 (adds TokenUsage.additional_counts — provider-specific counters bucket).
  • Schema: SCHEMA_VERSION = 2, stamped on KurrentDB metadata under $schema_version by integration writers.

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

kurrent_agent_schema-0.1.2.tar.gz (21.9 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.1.2-py3-none-any.whl (8.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: kurrent_agent_schema-0.1.2.tar.gz
  • Upload date:
  • Size: 21.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for kurrent_agent_schema-0.1.2.tar.gz
Algorithm Hash digest
SHA256 1d324b373adbcfa050d00345e1abee8c551befe218bfdd9a4183c084278a3dc7
MD5 14d01e9f62d353551c826f705f3288c9
BLAKE2b-256 543f4995f045cb524a9dc79a18f84aaf9c57b56258bece9267c69a4eec8e0b0d

See more details on using hashes here.

Provenance

The following attestation bundles were made for kurrent_agent_schema-0.1.2.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.1.2-py3-none-any.whl.

File metadata

File hashes

Hashes for kurrent_agent_schema-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 a8366ce00c8f97a3e580e46d9b9b4033d027c2df0aa3c953353c7437592a5ddb
MD5 ad2903387f7159ee0e56cd36c9877899
BLAKE2b-256 77518bdb07db8b20221864384e9ce807c71bf72eceb565ca9fb29e63d5ef947f

See more details on using hashes here.

Provenance

The following attestation bundles were made for kurrent_agent_schema-0.1.2-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.

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