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

Uploaded Python 3

File details

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

File metadata

  • Download URL: workstate_protocol-0.1.7.tar.gz
  • Upload date:
  • Size: 24.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.1.7.tar.gz
Algorithm Hash digest
SHA256 20a87ed57bbcaae759b9e7d410924d800bf7fa96b15686d3e8b94c48773ea264
MD5 88cc0733bfbd0fda368548b1ccf3cf04
BLAKE2b-256 785b0a1fa14d3d56753211c9a5a12ef538b665d1a7794e5735c54d74b6bf0b88

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for workstate_protocol-0.1.7-py3-none-any.whl
Algorithm Hash digest
SHA256 22953d89459b0694a93abc0acc39e9cb2383546aa8a681cab734a702e61cee42
MD5 188bf48c93d6cdc5e54d1d8bb1f7f0dd
BLAKE2b-256 258a0ad06138a10c4ac66cd79b09d7737cb5de8b06b9a9e6aa30c655dae9c068

See more details on using hashes here.

Provenance

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