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

Uploaded Python 3

File details

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

File metadata

  • Download URL: workstate_protocol-0.1.5.tar.gz
  • Upload date:
  • Size: 24.4 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.1.5.tar.gz
Algorithm Hash digest
SHA256 b15fbd48f6e61eff87aeafecb3a0d2938bb0e2b3df1fd2a517a49d613448cf4b
MD5 074c8a615a016028411001e43c667cfe
BLAKE2b-256 a56cdc1e5d36a438427ad7a4618ee8427f1bb10945d54c25a81464402357792b

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for workstate_protocol-0.1.5-py3-none-any.whl
Algorithm Hash digest
SHA256 c670506f7e89bdca45bd6568d1905464b4312db97a54932e5636b2fb06a36ab2
MD5 9fd6458506807ff8cf1afe5b41c66eb4
BLAKE2b-256 4e1932a8c7e09d7f785abe1e8cdf81dcd2ef50413baee4b637e7468b335ff761

See more details on using hashes here.

Provenance

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