Malformed YAML Recovery Skill

This skill provides guidance on identifying, debugging, and fixing malformed YAML syntax errors in configuration files, particularly focusing on common issues like unclosed brackets, invalid characters, and improper formatting.

What This Skill Does

Helps developers identify and fix YAML syntax errors in configuration files, skill definitions, and other YAML documents. Provides step-by-step debugging approaches and validation techniques.

Instructions

When a user encounters malformed YAML content or requests help with YAML syntax:

1. **Identify the Error Pattern**

- Look for unclosed brackets, braces, or quotes

- Check for invalid characters in keys or values

- Verify proper indentation (YAML uses spaces, not tabs)

- Ensure colons have spaces after them for key-value pairs

2. **Common YAML Issues to Check**

- Unclosed brackets: `[item1, item2` (missing `]`)

- Unquoted strings with special characters: `name: test@example` (should be quoted)

- Mixed indentation (tabs and spaces)

- Missing spaces after colons: `key:value` (should be `key: value`)

- Invalid list syntax

- Multiline strings without proper indicators (`|` or `>`)

3. **Validation Process**

- Use a YAML linter or parser to identify the exact error location

- Check line-by-line from the error position

- Verify the document structure follows YAML 1.2 specification

- Ensure all opening delimiters have matching closing delimiters

4. **Correction Strategy**

- Fix syntax errors while preserving the original intent

- Add quotes around strings with special characters

- Ensure proper indentation (typically 2 spaces per level)

- Close all brackets, braces, and quotes

- Validate the corrected YAML before proceeding

5. **Prevention Tips**

- Use a YAML-aware editor with syntax highlighting

- Enable YAML validation in your IDE

- Use online YAML validators for quick checks

- Follow consistent formatting conventions

Example Usage

**Input:** YAML file with unclosed bracket

```yaml

name: [invalid yaml with unclosed bracket

description: This YAML is malformed

```

**Output:** Corrected YAML

```yaml

name: "Invalid YAML Recovery Example"

description: "This YAML has been corrected and is now valid"

```

Constraints