What problem does it solve?
github-aw-syntax eliminates trial-and-error when authoring or debugging GitHub Agentic Workflows (.md files) by providing a comprehensive, schema-focused reference for the required frontmatter keys, engine configuration, networking/tooling rules, and safe-output patterns.
Core Features & Use Cases
- Frontmatter schema reference: Covers required and advanced fields such as
on:, permissions:, runs-on:, timeout-minutes:, secrets:, and imports: so workflows compile and behave as intended.
- Security guardrails: Explains the security model, including why write permissions are disallowed in the main job and how to use
safe-outputs for approved write operations.
- Networking and tool configuration guidance: Documents how to configure
network.allowed, MCP server tooling, and safe egress patterns to prevent blocked connections and runtime failures.
- Operational pitfalls & best practices: Highlights common issues like silent schema ignorance, network egress blocking, and improper permission placement.
Quick Start
Use the github-aw-syntax skill when you need to validate or correct the YAML frontmatter of a .md Agentic Workflow file before compiling or deploying it.