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.0 (initial pre-1.0 release carrying schema v2).
  • 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.0.tar.gz (21.6 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.0-py3-none-any.whl (7.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: kurrent_agent_schema-0.1.0.tar.gz
  • Upload date:
  • Size: 21.6 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.0.tar.gz
Algorithm Hash digest
SHA256 128b4f936ff77fa0149126ad8684840b70d65a6b8c95af90cdccdbb0bbfdbfdd
MD5 4f9bb401a56f7012daa65b7b28069861
BLAKE2b-256 43713ded7c4cf4e1183a60d0e791d071ca0376bc1468c533a094efb807cbcedd

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for kurrent_agent_schema-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 87a2c09690daebbf4c01e415474be5ab1d8eb91b2e37b057ccf62a1c32e350b3
MD5 8d616f07269f316b5dd091378456fd9a
BLAKE2b-256 f10a18fb6eb51078fefd1edcc5c498fe3ec82a8272d602ae099bfb96b1fbed0b

See more details on using hashes here.

Provenance

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

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