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.

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.3.0.tar.gz (26.6 kB view details)

Uploaded Jun 12, 2026 Source

Built Distribution

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

The dropdown lists show the available interpreters, ABIs, and platforms. Enable javascript to be able to filter the list of wheel files.

workstate_protocol-0.3.0-py3-none-any.whl (19.6 kB view details)

Uploaded Jun 12, 2026 Python 3

File details

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

File metadata

Download URL: workstate_protocol-0.3.0.tar.gz
Upload date: Jun 12, 2026
Size: 26.6 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.3.0.tar.gz
Algorithm	Hash digest
SHA256	`c7cf31fe4052bea47f18f8fec3ceeb8877adbbd468f25f2cf5af08791f51cfea`
MD5	`a10feaea235b18642ccd37397d805809`
BLAKE2b-256	`e3feb031bcc98eec7ed25b24b0376b22b2cf35d4a9133f5ddb24e014e012ea4d`

See more details on using hashes here.

Provenance

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

Statement:
- Statement type: https://in-toto.io/Statement/v1
- Predicate type: https://docs.pypi.org/attestations/publish/v1
- Subject name: workstate_protocol-0.3.0.tar.gz
- Subject digest: c7cf31fe4052bea47f18f8fec3ceeb8877adbbd468f25f2cf5af08791f51cfea
- Sigstore transparency entry: 1797858906
- Sigstore integration time: Jun 12, 2026
Source repository:
- Permalink: darce/workstate@ecfc6123ef53a0b30029f96564bce5a045419d1d
- Branch / Tag: refs/heads/main
- Owner: https://github.com/darce
- Access: private
Publication detail:
- Token Issuer: https://token.actions.githubusercontent.com
- Runner Environment: github-hosted
- Publication workflow: release-publish.yml@ecfc6123ef53a0b30029f96564bce5a045419d1d
- Trigger Event: workflow_dispatch