FlutterSDK Docs

FlutterSDK AI

适用于 FlutterSDK 生态系统的 AI 编码技能。
让你的 AI 助手掌握 Wind UI、Magic Framework 等知识，支持各大编码工具。

注册表 · 问题 · 快速开始

为什么？

AI 编码助手功能强大，但它们不了解你的框架。它们会臆造组件名称、猜测 API 用法，还会忽略惯例。

FlutterSDK AI 可以解决这个问题。 它为 AI 提供关于 Wind UI 的 className 系统、Magic Framework 受 Laravel 启发的架构等结构化知识，让 AI 首次就能生成正确的代码。

安装一次，适用所有工具：

技能

目前提供五项技能。完整说明请参阅 docs/SKILLS.md。

每项技能都与其上游包自己的 skills/ 目录保持一致，并会在对应包发布版本时同步到此处。确切的同步版本由 skills/<name>/SKILL.md 中的 version: 字段指定；skills/index.json 是机器可读索引。这两者都未在本表中重复，因此不会与表格内容出现偏差。

MCP 服务

mcp.fluttersdk.com 通过 Streamable HTTP 提供单个 search-docs 工具。 公开访问，无需身份验证。完整的客户端配置片段（Claude Code、Cursor、 OpenCode、Codex CLI、Gemini CLI、VS Code Copilot 等）见 docs/MCP.md。

对于仅支持 stdio 的客户端（Claude Desktop、旧版 Codex CLI）：

npx @fluttersdk/mcp

npx 桥接程序会将 stdio 请求透明地代理到上游 HTTP 服务。

快速开始

选项 1：npx skills（推荐）

最快的方式。适用于 40 多种 AI 编码 Agent。

# 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

选项 2：通用安装程序

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

选项 3：针对特定工具

{
    "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/

工作原理

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：获取 fluttersdk.github.io/ai/index.json，下载列出的技能文件并缓存在本地。

Claude Code：插件清单（.claude-plugin/plugin.json）使此仓库可供安装。skills/ 中的技能会自动发现，并以 /fluttersdk: 为命名空间。

部署：推送到 main → GitHub Actions 自动将 skills/ 部署到 GitHub Pages。

贡献

添加新技能

1. 创建 skills/<skill-name>/SKILL.md，并添加 YAML frontmatter（name、description）
2. 在 skills/<skill-name>/references/ 中添加参考文件
3. 更新 skills/index.json：在 files 数组中列出每个文件
4. 更新 .claude-plugin/plugin.json 和 .claude-plugin/marketplace.json 中的版本号
5. 推送到 main

完整规范请参见 CLAUDE.md。

重要：必须在 index.json 中列出每个文件：OpenCode 只会下载列出的文件。遗漏文件会导致用户获取的技能不完整。

许可证

MIT。详情请参见 LICENSE。

_{由 FlutterSDK 用心打造
如果这为你节省了时间，请点个星；这有助于其他人发现它。}