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.6.tar.gz (26.3 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.6-py3-none-any.whl (19.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: workstate_protocol-0.2.6.tar.gz
  • Upload date:
  • Size: 26.3 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.6.tar.gz
Algorithm Hash digest
SHA256 27e85d02ec55538b9b5096f6202b3d271e316895def2d7c7f1210744361ceae6
MD5 18babd14229463a8a6e30b7ed6d9fe32
BLAKE2b-256 ea70ec3767feaa59fe62a22f2224acc81c87a76d68d9444255089d6ea2d6e386

See more details on using hashes here.

Provenance

The following attestation bundles were made for workstate_protocol-0.2.6.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.6-py3-none-any.whl.

File metadata

File hashes

Hashes for workstate_protocol-0.2.6-py3-none-any.whl
Algorithm Hash digest
SHA256 b4bca2671970ac4ad026819e6b1d20be82b54688ab08e0afa1ae8f2fe040ff2c
MD5 99b5ec3f0e637965097d31c107373e71
BLAKE2b-256 efa8975a6e61589807f939399c3e1a7713980fcbf2c60e8276753fa70ffa4be5

See more details on using hashes here.

Provenance

The following attestation bundles were made for workstate_protocol-0.2.6-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