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 plan 0001)

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.6.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.6-py3-none-any.whl (18.2 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for workstate_protocol-0.1.6.tar.gz
Algorithm Hash digest
SHA256 b7ba1b736d9023fd63a58a9691e9c85101c4ebf90e91b9386ee139de75141191
MD5 7ec2800ceffb43793b1b7bd5bc344cae
BLAKE2b-256 c370f245c3f2005ad5ea9c5ded0ca3b0c21a644434fcd4f2f1a31342ecc22159

See more details on using hashes here.

File details

Details for the file workstate_protocol-0.1.6-py3-none-any.whl.

File metadata

File hashes

Hashes for workstate_protocol-0.1.6-py3-none-any.whl
Algorithm Hash digest
SHA256 7b8297460c8089caf33a6294a0cb45bd5a933b9f4dab2b01848b11dbe6f1eaf2
MD5 c1cb4e3c172cd5786a37e86d645bf2f4
BLAKE2b-256 7a3462dd46f33375b84e8b27a3cd7224abcb78259a2c5b3d7b1e3306199e4abd

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