This project provides an agent skill designed to enhance the accuracy and quality of SwiftData code generated by AI coding assistants like Claude Code, Codex, and Gemini. It targets common errors and misconceptions LLMs have with SwiftData, offering developers a way to improve AI-assisted SwiftData development and reduce post-generation debugging.

How It Works

The skill functions as a specialized plugin for AI coding tools, embedding targeted rules and checks derived from deep expertise in SwiftData. It focuses on nuanced aspects such as new features, frequently mishandled older features, and patterns crucial for correctness and efficiency, specifically addressing mistakes LLMs tend to make rather than covering fundamental concepts they already grasp.

Quick Start & Requirements

• Install: Use npx skills add https://github.com/twostraws/swiftdata-agent-skill --skill swiftdata-pro.
• Prerequisites: Node.js must be installed (brew install node if npx is unavailable).
• Documentation: A YouTube video, "How to Install and Use Agent Skills in Xcode," is available for guidance. Further agent skills can be found at Swift Agent Skills.

Highlighted Details

• Covers advanced SwiftData topics including @Model, @Query, predicates, indexes, migrations, relationships, and iCloud sync.
• Specifically designed to address common errors made by Large Language Models (LLMs) in SwiftData code.
• Focuses on edge cases, surprising behaviors, and soft deprecations relevant to SwiftData development.

Maintenance & Community

This skill is a project by Paul Hudson of Hacking with Swift. Contributions are welcomed, focusing on adding new checks, improving existing ones, or refining documentation, all under the MIT license.

Licensing & Compatibility

The project is licensed under the MIT License, permitting commercial use, modification, distribution, and private use without significant restrictions.

Limitations & Caveats

The skill deliberately avoids covering fundamental SwiftData concepts already known by LLMs to conserve token usage. Users should be mindful of potential token costs associated with using agent skills.