Documentation

pyhall docs

Everything you need to govern AI workers with the Worker Class Protocol — from quick start to full reference.

🚀

Getting Started

Introduction
What pyhall and the Worker Class Protocol are, why they exist, and who they're for.
Quick Start
Install pyhall, scaffold your first worker, and make a routing decision in under 5 minutes.
What's New in v0.3.0
Hall Monitor, full-package attestation, skill compilation, and platform expansion.
📐

Concepts

Workers
Worker IDs, species vs instances, risk tiers, and the full lifecycle.
Capabilities
Capability-based routing, ID format rules, namespace ownership, and the taxonomy.
Policies & Risk
Risk tiers, blast radius, policy profiles, the PolicyGate, controls, and dispatch outcomes.
Decisions & Routing
RouteInput, routing flow, RouteDecision structure, deny codes, and the decision log.
Attestation
Signed capability cards, supply chain trust, full-package attestation, and compliance.
Telemetry & Privacy
What stays local, what touches the registry, and why.
⚙️

SDKs

Python SDK
pip install pyhall-wcp — make_decision(), PolicyGate, attestation, Hall API server, CLI.
TypeScript SDK
npm install @pyhall/core — makeDecision(), RegistryClient, PolicyGate, @pyhall/cli.
Go SDK
go get github.com/pyhall/pyhall-go — MakeDecision(), Registry, CLI.
📖

Reference

Hall API
Server setup, environment variables, all endpoints, and database schema.
Hall Monitor
The desktop app — setup, authentication, six screens, poll behavior.
Capability Catalog
Interactive catalog of all 245 taxonomy entities across 27 domains.
🖥️

Dashboard

Overview
Your registry control plane — stat cards, usage meters, and account standing at a glance.
Namespaces
Claim community and org namespaces, manage team members, and inspect hall sessions.
Workers
View registered workers and active Hall enrollment sessions across all namespaces.
API Keys
Generate machine credentials, set scopes, and revoke keys for Hall API enrollment.
Account & Billing
Manage your subscription, upgrade or downgrade plans, payment methods, and account settings.
🛠️

Skills & Tools

Skills Overview
Write governed skills once — pyhall compiles adapters for MCP, OpenAI, Gemini, LangChain.
Platform Matrix
Tier definitions and confirmed platform support across all runtimes.
Security & Governance
Kill switch, fail-closed behavior, PolicyGate enforcement, and the core security model.
Platform Integrations
16 platforms — MCP, OpenAI, Gemini, LangChain, CrewAI, LlamaIndex, Zapier, n8n, and more.
🔌

Examples & Integrations

Examples & Integrations
Workers and integrations for Discord, MCP hosts, and more — Python, TypeScript, and Go. Community contributions welcome.
Roadmap
Planned language SDKs — PHP, Ruby, Rust, Elixir, Java, .NET/C#, Kotlin, Swift, C/C++, Dart, Lua, and more.
pyhall-examples on GitHub ↗
Browse the examples index. Language-specific repos for Python, TypeScript, and Go.
📋

Specification

WCP v0.1 Specification ↗
The full language-agnostic Worker Class Protocol specification at workerclassprotocol.dev.