https://github.com/fluttersdk/ai
Teach your AI assistant Wind UI, Magic Framework, and more — across every major coding tool.
https://github.com/fluttersdk/ai
flutter magic-framework skills wind-ui
Last synced: 1 day ago
JSON representation
Teach your AI assistant Wind UI, Magic Framework, and more — across every major coding tool.
- Host: GitHub
- URL: https://github.com/fluttersdk/ai
- Owner: fluttersdk
- License: mit
- Created: 2026-03-02T23:06:03.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2026-07-01T00:08:11.000Z (26 days ago)
- Last Synced: 2026-07-01T01:22:25.197Z (26 days ago)
- Topics: flutter, magic-framework, skills, wind-ui
- Language: Shell
- Homepage:
- Size: 690 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
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:
| Tool | Integration |
|:-----|:------------|
| [OpenCode](https://github.com/opencodetool/opencode) | URL-based skill registry |
| [Claude Code](https://docs.anthropic.com/en/docs/claude-code) | Plugin + Marketplace |
| [Cursor](https://cursor.sh) | Rules (`.mdc`) |
| [Gemini CLI](https://github.com/google-gemini/gemini-cli) | Command templates (`.toml`) |
| [VS Code Copilot](https://code.visualstudio.com/) | Instructions (`.md`) |
| [Codex CLI](https://github.com/openai/openai-codex) | MCP config (`~/.codex/config.toml`) |
| [Antigravity CLI](https://github.com/antigravity-cli/antigravity) | MCP config (`~/.gemini/config/mcp_config.json`) |
| [Cline](https://github.com/cline/cline) | MCP config (`.mcp.json`) |
| [Roo Code](https://github.com/RooVetGit/Roo-Code) | MCP config (`.mcp.json`) |
## Skills
Five skills are available. See [docs/SKILLS.md](docs/SKILLS.md) for full descriptions.
| Skill | Version | What it covers |
|:------|:--------|:---------------|
| `wind-ui` | 1.0.0-alpha.6 | W-prefix widgets, `className` utility system, dark mode, responsive breakpoints |
| `magic-framework` | 1.0.0-alpha.13 | IoC container, 17 facades, Eloquent ORM, GoRouter, forms, testing |
| `fluttersdk-dusk` | 0.0.2 | E2E driver: 31 MCP tools to snap, tap, type, screenshot a running Flutter app |
| `fluttersdk-telescope` | 0.0.1 | Runtime inspector: 9 ring buffers for HTTP, logs, exceptions, DB queries |
| `fluttersdk-artisan` | 0.0.1 | CLI framework + stdio MCP server, 21 commands, plugin scaffold, `artisan_tinker` |
## 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](docs/MCP.md).
For clients that only support stdio (Claude Desktop, older Codex CLI):
```bash
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](https://github.com/vercel-labs/skills).
```bash
# 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
```bash
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
OpenCode
Add the registry URL to your `opencode.json`:
```json
{
"skills": {
"urls": ["https://fluttersdk.github.io/ai/"]
}
}
```
Skills are fetched automatically and cached locally.
Claude Code
```bash
/plugin marketplace add https://raw.githubusercontent.com/fluttersdk/ai/main/.claude-plugin/marketplace.json
/plugin install fluttersdk@fluttersdk-marketplace
```
The plugin auto-registers:
- 5 skills (`/fluttersdk:wind-ui`, `/fluttersdk:magic-framework`, `/fluttersdk:fluttersdk-dusk`, `/fluttersdk:fluttersdk-telescope`, `/fluttersdk:fluttersdk-artisan`)
- `/fluttersdk:flutter-review` and `/fluttersdk:flutter-test` slash commands
- `fluttersdk` MCP server (HTTP transport to `mcp.fluttersdk.com`; no manual `.mcp.json` edit required)
Cursor
```bash
mkdir -p .cursor/rules
cp tool-templates/cursor/fluttersdk.mdc .cursor/rules/
```
Activates automatically for all `.dart` files.
Gemini CLI
```bash
mkdir -p ~/.gemini/commands
cp tool-templates/gemini/*.toml ~/.gemini/commands/
```
Use with `/flutter-review` and `/flutter-test` commands.
VS Code Copilot
```bash
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.md` with YAML frontmatter (`name`, `description`)
2. Add reference files in `skills//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](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](LICENSE) for details.
---
Built with care by FlutterSDK
If this saves you time, give it a star — it helps others discover it.