workbay-protocol
Component of the
workbaystack. You usually installworkbay, 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.
1 maintainer
Metadata
1 maintainer
Release files for workbay-protocol 0.2.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| workbay_protocol-0.2.0.tar.gz | 27.9 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| workbay_protocol-0.2.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 49.0 kB
Release files / workbay_protocol-0.2.0.tar.gz
| Download URL | workbay_protocol-0.2.0.tar.gz |
|---|---|
| Size | 27.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
f99acc0e7c7d0b83f6349df2e7ef5880a221f35a56260fc8cb0e84212f4e9506
|
|
BLAKE2b-256 checksum How to use checksums |
91ab80be796158c94ff63a332ec3f52991d04a713894d0fc5b67c3d8342f3587
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.12.13
|
Release files / workbay_protocol-0.2.0-py3-none-any.whl
| Download URL | workbay_protocol-0.2.0-py3-none-any.whl |
|---|---|
| Size | 21.1 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
123463ae650e6126ce943e72eb0f1c6a473a39df77bff0f9d4890890a76fd001
|
|
BLAKE2b-256 checksum How to use checksums |
0912b13d986efacbfde101db2c66eee5b14bd33fba08fef9060bfbedb2e9f0bc
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.12.13
|
