Synced package doc
Docs/prompts-gpt Package/YAML Frontmatter Reference

YAML Frontmatter Reference

Complete reference for YAML frontmatter in prompt and sweep Markdown files.

Prompt File Frontmatter

---
title: "Security Review"
slug: "security-review"
source: "library"
category: "Code Review"
difficulty: "Intermediate"
outputType: "Text"
supportedTools:
  - Codex
  - Claude
  - Cursor
tags:
  - security
  - review
  - owasp
variables:
  - targetDir
  - severity
agentTargets:
  - codex
  - cursor
recommendedPath: ".prompts-gpt/security-review.md"
---

Fields

FieldTypeRequiredDescription
titlestringYesDisplay name
slugstringYesURL-safe identifier (must be unique)
sourcestringNo"library" or "generated"
categorystringNoCategory for organization
difficultystringNo"Beginner" / "Intermediate" / "Advanced"
outputTypestringNoExpected output format
supportedToolsstring[]NoCompatible agent tools
tagsstring[]NoSearch/filter tags
variablesstring[]NoDeclared variable names
agentTargetsstring[]NoTarget agents for sync
recommendedPathstringNoSuggested file path

Sweep File Frontmatter

---
title: "Security Audit Sweep"
slug: "security-audit-sweep"
category: "Security"
sweep:
  defaultIterations: 5
  maxIterations: 10
  summaryLines: 40
  strategy: "sequential"
  phase: "security-hardening"
  eval:
    criteria:
      - correctness
      - completeness
      - thoroughness
    passThreshold: 0.8
---

Sweep-Specific Fields

FieldTypeDefaultDescription
sweep.defaultIterationsnumber3Default iteration count
sweep.maxIterationsnumber10Maximum allowed iterations
sweep.summaryLinesnumber40Lines per summary extraction
sweep.strategystring"sequential""sequential" or "parallel"
sweep.phasestringPhase label for context
sweep.eval.criteriastring[]Self-evaluation scoring dimensions
sweep.eval.passThresholdnumber0.7Pass/fail score threshold (0.0–1.0)

Orchestration Pipeline File

{
  "mode": "pipeline",
  "defaults": {
    "agent": "codex",
    "model": "gpt-5.5",
    "timeoutSeconds": 600
  },
  "steps": [
    {
      "name": "research",
      "promptFile": ".prompts-gpt/orchestrations/pipeline-steps/research.md",
      "agent": "claude",
      "model": "claude-sonnet-4-20250514"
    },
    {
      "name": "implement",
      "promptFile": ".prompts-gpt/orchestrations/pipeline-steps/implement.md"
    },
    {
      "name": "review",
      "promptFile": ".prompts-gpt/orchestrations/pipeline-steps/review.md",
      "agent": "cursor"
    }
  ]
}

Pipeline Step Fields

FieldTypeRequiredDescription
namestringYesStep name
promptFilestringYesPrompt file path
agentstringNoProvider override
modelstringNoModel override
timeoutSecondsnumberNoStep timeout

Manifest File

manifest.json is auto-generated by sync:

{
  "version": 1,
  "syncedAt": "2026-05-21T14:30:00Z",
  "prompts": [
    {
      "slug": "security-review",
      "title": "Security Review",
      "path": ".prompts-gpt/security-review.md",
      "category": "Code Review",
      "tags": ["security"]
    }
  ]
}

Validation

prompts-gpt validate

Validates all YAML frontmatter in .prompts-gpt/ for syntax and schema compliance.

See Also

YAML Frontmatter Reference | prompts-gpt Documentation | Prompts-GPT.com