Skip to main content

Typed cross-repo contracts for the Workstate system: handoff state, MCP I/O, hook events, skill manifests, bootstrap install manifest.

Project description

workstate-protocol

Single source of truth for cross-repo contracts in the Workstate system. Pydantic v2 is canonical; JSON Schema artifacts under schemas/ are generated from the models so non-Python consumers (hook scripts, future TS/JS tooling) can validate without importing Python.

Schemas (rolled out incrementally per founding implementation note)

Status Module Schema
✅ v0.1.0 workstate_protocol.handoff HandoffState, ActiveTask, TaskRef, TargetWorktree, TaskPlanRef
✅ v0.1.0 workstate_protocol.branch_naming TASK_REF_RE, derive_task_ref_candidates, format_suggested_branch_name (single source of truth for the feature-branch grammar enforced by the post-checkout / PreToolUse / pre-commit / pre-push gates; cross-package consumers like workstate_handoff_mcp re-export by reference, never by literal copy — identity is the contract)
workstate_protocol.mcp MCP tool I/O envelopes
workstate_protocol.hooks SessionStart, UserPromptSubmit, PreToolUse, PostToolUse, Stop
workstate_protocol.skills SkillManifest (with `scope: harness
workstate_protocol.bootstrap Bootstrap install manifest

Generated artifacts

schemas/*.json is regenerated by scripts/generate_schemas.py and committed. Consumers that don't want to import Python can read the JSON Schema directly.

Versioning

Hard-pin major version per consumer. Bootstrap resolves a compatible quartet of (handoff, orchestrator, bootstrap, system) against a single workstate-protocol major.

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

workstate_protocol-0.2.5.tar.gz (26.0 kB view details)

Uploaded Source

Built Distribution

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

workstate_protocol-0.2.5-py3-none-any.whl (19.2 kB view details)

Uploaded Python 3

File details

Details for the file workstate_protocol-0.2.5.tar.gz.

File metadata

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

File hashes

Hashes for workstate_protocol-0.2.5.tar.gz
Algorithm Hash digest
SHA256 c7a95c3c41feb55fabc890b4bf603dbd0e0e2a20e9e22eee30513217bb2afbf1
MD5 b92a60ef436f96d5a9a5a03e87173d74
BLAKE2b-256 c012abb8faf3c000f416d44f9ad0efb7f38070f1f55bc7d3aad2a27e91af10fa

See more details on using hashes here.

Provenance

The following attestation bundles were made for workstate_protocol-0.2.5.tar.gz:

Publisher: release-publish.yml on darce/workstate

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

File details

Details for the file workstate_protocol-0.2.5-py3-none-any.whl.

File metadata

File hashes

Hashes for workstate_protocol-0.2.5-py3-none-any.whl
Algorithm Hash digest
SHA256 ef7f76bb1ea00d41b34dfd4beff894e866d15a7c0f5bab37b0a6322aeaa1a114
MD5 e921217a732b09a65a834cd81bb28a13
BLAKE2b-256 5222753445465c222d9226c09f0d92224198d47ddb6f24ee6893030a24c32c60

See more details on using hashes here.

Provenance

The following attestation bundles were made for workstate_protocol-0.2.5-py3-none-any.whl:

Publisher: release-publish.yml on darce/workstate

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