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

Uploaded Python 3

File details

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

File metadata

  • Download URL: workstate_protocol-0.2.7.tar.gz
  • Upload date:
  • Size: 16.5 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.7.tar.gz
Algorithm Hash digest
SHA256 19dcf722b28a6ad71c62ab41540affef0fe8df311c79a2b6dd2495246dcf52a5
MD5 4cc0d43d1dad9596e88b19e3ab77636e
BLAKE2b-256 913eefa2738d7f2f314ad9aa733af0ff66bd47e93ac45816cf427090dc2ce452

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for workstate_protocol-0.2.7-py3-none-any.whl
Algorithm Hash digest
SHA256 9f80f1e7b3a21d0519861d9c16b96ce2da757636ca08255ff9bdf8eb0ab85803
MD5 a7318bea2553183c3e71968e9307ddf3
BLAKE2b-256 99ba520f131466f9bf03e8002d66f433f165978ed380dc1080487cf1155b1746

See more details on using hashes here.

Provenance

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