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.
1 maintainer
Metadata
1 maintainer
Release files for workstate-protocol 0.3.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| workstate_protocol-0.3.0.tar.gz | 26.6 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| workstate_protocol-0.3.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 46.3 kB
Release files / workstate_protocol-0.3.0.tar.gz
| Download URL | workstate_protocol-0.3.0.tar.gz |
|---|---|
| Size | 26.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
c7cf31fe4052bea47f18f8fec3ceeb8877adbbd468f25f2cf5af08791f51cfea
|
|
BLAKE2b-256 checksum How to use checksums |
e3feb031bcc98eec7ed25b24b0376b22b2cf35d4a9133f5ddb24e014e012ea4d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.12
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Jun 12, 2026.
Transparency logRelease files / workstate_protocol-0.3.0-py3-none-any.whl
| Download URL | workstate_protocol-0.3.0-py3-none-any.whl |
|---|---|
| Size | 19.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
063b2ce78f6828d3335ba1cbd1773b2815f86a81c9b248362e157916d51277cd
|
|
BLAKE2b-256 checksum How to use checksums |
71978492bb9548998a16ce561d51ea24cfb393c2c468e528846083203f1e6fe0
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.12
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Jun 12, 2026.
Transparency log
