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

Uploaded Python 3

File details

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

File metadata

  • Download URL: workstate_protocol-0.2.1.tar.gz
  • Upload date:
  • Size: 25.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.1.tar.gz
Algorithm Hash digest
SHA256 cb7657c3f0c934d1c0c11d667dabc1cf77acbce398964b22216b3d2d431d5469
MD5 f9231f9394d7d4f3739d1df42963d89e
BLAKE2b-256 fbeb0f3bb3d4706ef8e2488cd10a3da7277e2c55960b222bfd98cdaac844c8ed

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for workstate_protocol-0.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 b28cd9c6c6cdb4a98f80d7c680248bebaf016c57048e2b4ab86f89e3fd30741d
MD5 58e5fae5fc2e983e7b4557f4de396083
BLAKE2b-256 33fd2d1a6bfba00c5eb8c32af635f1dde1ec2c1819fed649554dd7a03c498aa6

See more details on using hashes here.

Provenance

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