Skip to main content

workbay-protocol

Component of the workbay stack. You usually install workbay, not this package directly.

Single source of truth for cross-repo contracts in the WorkBay 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 workbay_protocol.handoff HandoffState, ActiveTask, TaskRef, TargetWorktree, TaskPlanRef
✅ v0.1.0 workbay_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 workbay_handoff_mcp re-export by reference, never by literal copy — identity is the contract)
workbay_protocol.mcp MCP tool I/O envelopes
workbay_protocol.hooks SessionStart, UserPromptSubmit, PreToolUse, PostToolUse, Stop
workbay_protocol.skills SkillManifest (with `scope: harness
workbay_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 workbay-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

workbay_protocol-0.2.0.tar.gz (27.9 kB view details)

Uploaded Source

Built Distribution

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

workbay_protocol-0.2.0-py3-none-any.whl (21.1 kB view details)

Uploaded Python 3

File details

Details for the file workbay_protocol-0.2.0.tar.gz.

File metadata

  • Download URL: workbay_protocol-0.2.0.tar.gz
  • Upload date:
  • Size: 27.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.13

File hashes

Hashes for workbay_protocol-0.2.0.tar.gz
Algorithm Hash digest
SHA256 f99acc0e7c7d0b83f6349df2e7ef5880a221f35a56260fc8cb0e84212f4e9506
MD5 99a0e00dbd75192b3a4955b02ce7887c
BLAKE2b-256 91ab80be796158c94ff63a332ec3f52991d04a713894d0fc5b67c3d8342f3587

See more details on using hashes here.

File details

Details for the file workbay_protocol-0.2.0-py3-none-any.whl.

File metadata

File hashes

Hashes for workbay_protocol-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 123463ae650e6126ce943e72eb0f1c6a473a39df77bff0f9d4890890a76fd001
MD5 f44a6d900a77083d30de7c0ad6977b26
BLAKE2b-256 0912b13d986efacbfde101db2c66eee5b14bd33fba08fef9060bfbedb2e9f0bc

See more details on using hashes here.

Release history Release notifications | RSS feed

This release

0.2.0 This release

2 files

0.1.0

2 files

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page