Skill Requirements
Reference for the REQUIREMENTS.yaml format — how to declare connections, dependencies, scopes, and validation rules for WorkClaw skills.
What is REQUIREMENTS.yaml?
Every skill includes a REQUIREMENTS.yaml file that declares what the skill needs in order to function. WorkClaw reads this manifest before installation and blocks the install if the user's environment doesn't meet the requirements. This prevents broken installs and gives users a clear checklist of what to set up.
What does the format look like?
A typical REQUIREMENTS.yaml contains sections for connections, dependencies, and constraints:
connections:
- provider: google
scopes:
- gmail.send
- gmail.read
- calendar.events
required: true
- provider: slack
scopes:
- chat.write
required: false
dependencies:
- skill: research-assistant
minVersion: "2.1.0"
constraints:
minPlan: team
Each section is optional. A skill with no external needs can ship an empty or minimal REQUIREMENTS.yaml.
How do connections requirements work?
The connections array lists each connection the skill relies on. Each entry specifies:
- provider — The connection provider identifier (e.g.,
google,slack,linear,custom). - scopes — An array of permission scopes the skill needs from that provider. WorkClaw displays these to the user during installation so they know exactly what access is being requested.
- required — Whether the connection is mandatory (
true) or optional (false). Optional connections enable extra features but aren't needed for core functionality.
If a required connection is missing, WorkClaw prompts the user to set it up before completing the install.
How do skill dependencies work?
The dependencies array lets a skill declare that it relies on another skill being installed on the same Claw. Each entry specifies the skill identifier and an optional minimum version. WorkClaw checks dependencies at install time and offers to install missing skills automatically.
What constraints can I set?
The constraints section supports:
- minPlan — The minimum WorkClaw plan tier required (e.g.,
starter,team,enterprise). Users on a lower tier see an upgrade prompt. - region — Restrict the skill to specific data regions if compliance requires it.
How does validation work?
WorkClaw validates REQUIREMENTS.yaml at two points:
- Publish time — When you save or publish a skill, WorkClaw checks the YAML syntax and verifies that referenced providers and scopes are valid. Invalid manifests are rejected with specific error messages.
- Install time — When a user installs the skill, WorkClaw evaluates requirements against their environment. Missing connections, insufficient plan tier, or unmet dependencies are surfaced in a checklist dialog. The user can resolve each item inline before confirming the install.
For skill packs, WorkClaw merges the requirements of all included skills and deduplicates shared connections so the user authorizes each provider only once.