FlutterSDK Docs

FlutterSDK AI

AI coding skills for the FlutterSDK ecosystem.
Teach your AI assistant Wind UI, Magic Framework, and more, across every major coding tool.

Registry · Issues · Quick Start

Why?

AI coding assistants are powerful, but they don't know your frameworks. They hallucinate widget names, guess at API patterns, and miss conventions.

FlutterSDK AI fixes this. It gives your AI structured knowledge about Wind UI's className system, Magic Framework's Laravel-inspired architecture, and more, so it generates correct code on the first try.

One install, every tool:

Skills

Five skills are available. See docs/SKILLS.md for full descriptions.

Each skill mirrors its upstream package's own skills/ directory and arrives here when that package publishes a release. The exact synced version is the version: field in skills/<name>/SKILL.md, and skills/index.json is the machine-readable index; neither is duplicated in this table, so neither can drift from it.

MCP Server

mcp.fluttersdk.com exposes a single search-docs tool via Streamable HTTP. Public, no auth required. Full client config snippets (Claude Code, Cursor, OpenCode, Codex CLI, Gemini CLI, VS Code Copilot, and more) are in docs/MCP.md.

For clients that only support stdio (Claude Desktop, older Codex CLI):

npx @fluttersdk/mcp

The npx bridge proxies stdio to the upstream HTTP server transparently.

Quick Start

Option 1: npx skills (Recommended)

The fastest way. Works with 40+ AI coding agents.

# Install all FlutterSDK skills to all detected agents
npx skills add fluttersdk/ai

# Install a specific skill
npx skills add fluttersdk/ai --skill wind-ui

# Install globally (available across all projects)
npx skills add fluttersdk/ai -g

Option 2: Universal Installer

git clone https://github.com/fluttersdk/ai.git && cd ai

# Preview what would be installed
bash scripts/install.sh --dry-run --global

# Install globally for all detected tools
bash scripts/install.sh --global

# Install globally and register the MCP server for all detected tools
bash scripts/install.sh --global --with-mcp

# Or install into your current Flutter project
bash scripts/install.sh --project

Option 3: Tool-Specific

{
    "skills": {
        "urls": ["https://fluttersdk.github.io/ai/"]
    }
}

/plugin marketplace add https://raw.githubusercontent.com/fluttersdk/ai/main/.claude-plugin/marketplace.json
/plugin install fluttersdk@fluttersdk-marketplace

mkdir -p .cursor/rules
cp tool-templates/cursor/fluttersdk.mdc .cursor/rules/

mkdir -p ~/.gemini/commands
cp tool-templates/gemini/*.toml ~/.gemini/commands/

mkdir -p .github
cp .github/copilot-instructions.md .github/

How It Works

skills/index.json              ← OpenCode fetches this from GitHub Pages
  → wind-ui/SKILL.md           ← Skill definition + className rules
  → wind-ui/references/*.md    ← On-demand widget docs, layout patterns, tokens
  → magic-framework/SKILL.md   ← Skill definition + framework laws
  → magic-framework/refs/*.md  ← Controllers, ORM, facades, routing, auth, ...

OpenCode: Fetches fluttersdk.github.io/ai/index.json, downloads listed skill files, caches locally.

Claude Code: Plugin manifest (.claude-plugin/plugin.json) makes the repo installable. Skills in skills/ are auto-discovered and namespaced under /fluttersdk:.

Deployment: Push to main → GitHub Actions deploys skills/ to GitHub Pages automatically.

Contributing

Adding a New Skill

1. Create skills/<skill-name>/SKILL.md with YAML frontmatter (name, description)
2. Add reference files in skills/<skill-name>/references/
3. Update skills/index.json: list every file in the files array
4. Bump version in .claude-plugin/plugin.json and .claude-plugin/marketplace.json
5. Push to main

See CLAUDE.md for the full specification.

Important: Every file must be listed in index.json: OpenCode only downloads listed files. Forgetting a file means users get incomplete skills.

License

MIT. See LICENSE for details.

_{Built with care by FlutterSDK
If this saves you time, give it a star; it helps others discover it.}