Skip to main content

Typed cross-repo contracts for the WorkBay system: handoff state, MCP I/O, hook events, skill manifests, bootstrap install manifest.

Project description

workbay-protocol

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.

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

workbay_protocol-0.1.0.tar.gz (26.6 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.1.0-py3-none-any.whl (19.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: workbay_protocol-0.1.0.tar.gz
  • Upload date:
  • Size: 26.6 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.1.0.tar.gz
Algorithm Hash digest
SHA256 068afb969bdb081e99c2fc309806e0f2ed1e7999b5dd4ca45b230ec5d36defe9
MD5 c9cbfebe463f3eebb7881c27c6a8e228
BLAKE2b-256 00bea5e4a61b64c589f4147cd0a8835188362895ca753f928b1440c01d1c73f4

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for workbay_protocol-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 a47e8beab4a6055f4510843988844428c00e4340f79e301c06dc96f95042100b
MD5 b00bf972e4ee8ce4d82138899c387897
BLAKE2b-256 8002111ae9d6351259a2bc4c9a6fa304e95ca4a954af5ed4bd8f077b3626584c

See more details on using hashes here.

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