github-aw-syntax

Validate GitHub Agentic Workflow YAML frontmatter for correct and secure configuration.

3|1|Updated Apr 12, 2026
One-click install
npx skills add https://github.com/Cogni-AI-OU/cogni-ai-agent-skills --skill github-aw-syntax
Or copy as Structured Prompt for Agentā–¼
Please help me install this Agent Skill.
Skill: github-aw-syntax
Source: https://github.com/Cogni-AI-OU/cogni-ai-agent-skills/tree/main/github-aw-syntax
Command: npx skills add https://github.com/Cogni-AI-OU/cogni-ai-agent-skills --skill github-aw-syntax

SYSTEM DOCUMENTATION & REQUIREMENTS

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.

Frequently Asked Questions about github-aw-syntax

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I configure GitHub Agentic Workflow frontmatter to prevent permission errors?ā–¼

GitHub Agentic Workflow frontmatter requires explicit permission boundaries. Write permissions are disallowed in the main job, requiring safe-outputs for approved write operations to prevent security violations and runtime failures.

Why does my GitHub Agentic Workflow fail due to network egress blocking?ā–¼

Network egress blocking in GitHub Agentic Workflows occurs without explicit allowlist configuration. You must configure network.allowed in the frontmatter to define safe egress patterns and prevent blocked connections during agent execution.

What YAML frontmatter keys are required for GitHub Agentic Workflows?ā–¼

Required GitHub Agentic Workflow frontmatter keys include on:, permissions:, runs-on:, timeout-minutes:, secrets:, and imports:. Advanced fields configure engines, networking, and tool permissions for proper agent execution scenarios.

How do I use safe-outputs for write operations in GitHub Agentic Workflows?ā–¼

Safe-outputs in GitHub Agentic Workflows provide the mechanism for approved write operations. Since write permissions are disallowed in the main job, safe-outputs define approved write boundaries to maintain security while allowing necessary modifications.

Can I use MCP servers with GitHub Agentic Workflows for tool configuration?ā–¼

MCP servers can be configured in GitHub Agentic Workflow frontmatter for tooling. The workflow schema supports MCP server integration alongside network allowlists and safe egress patterns to prevent blocked connections and runtime failures.

What are common pitfalls when authoring GitHub Agentic Workflow YAML schemas?ā–¼

Common GitHub Agentic Workflow pitfalls include silent schema ignorance, network egress blocking, and improper permission placement. Using a schema-focused reference ensures frontmatter keys, engine configuration, and security boundaries are correctly structured.