Frame Relay

io.github.Joseph-Brendan由 GitHub 账号 Joseph-Brendan 发布v0.1.0-beta.0更新于 Oct 24, 2026

MCP server for the Frame-Relay design kit: components, tokens and live Figma selections.

已验证STDIO仅桌面开发者工具媒体与设计

概览

AI 生成的概览

Frame Relay 是一个本地 MCP 服务器,把 Figma 设计套件(组件、令牌和规则)交给 AI 编程助手,让它按你的设计构建界面。

可以做什么
读取设计套件:从 Figma 导出的组件规格、属性、设计令牌、图标和截图(JSON 与图片),让助手使用真实组件而不是靠截图猜测。遵循套件规则:写入项目的规则文件会阻止助手自造原始按钮或硬编码颜色。实时模式(可选):将 Figma 与助手配对,使其能读取你在 Figma 中当前选中的图层,从未导出的设计直接构建。README 提到助手会调用 10 个工具,并提供资源和客户端配置。
适用场景
适合把 Figma 设计系统作为唯一事实来源、同时让 Cursor、OpenCode、Antigravity 或 Claude Code 等 AI 编程工具编写 React 与 Tailwind 界面的设计师和小团队。当你希望生成的页面复用现有组件和令牌而不是自创样式时使用。
运行要求
通过 npx 从 npm 包 @frame-relay/cli 以 stdio 在本地运行(目前仅以 beta 标签发布)。需要 Node.js、由 CLI 的 init 和 sync 命令配置好的 React 项目、用于导出套件的 Frame Relay Figma 插件,以及一个 AI 编程工具。未声明认证、环境变量或请求头。实时模式需要用 6 位验证码将 Figma 配对。
安装前请注意
处于公开测试阶段,可能有粗糙之处。CLI 会向项目写入文件,包括 MCP 客户端配置和规则文件,并会合并进 opencode.json 等现有配置,提交前请检查改动。实时模式会把 Figma 会话连接到助手,你在 Figma 中选中的内容都可能被读取。同步会重新生成代码,不过据称对生成组件的手动修改会被保留。

安装

在 SourceWeft 中

  1. 打开 控制台中的 Frame Relay,将其添加到工作区。
  2. 为需要使用其工具的对话启用该服务。

Desktop only,通过 STDIO。 STDIO 服务会启动本地进程,因此需要 SourceWeft 桌面宿主。

其他 MCP 客户端

参照 仓库 中的启动说明。

README

Frame-Relay

Turn your Figma components into a design kit your AI coding agent follows.

New to this? Follow the step-by-step setup guide for designers.

[npm beta] [CI] [License: MIT]

Status: public beta. Commands below install the beta tag of the CLI. Expect rough edges and tell us what you find with the beta feedback form.

Frame-Relay is for designers who already work with AI coding tools like OpenCode or Antigravity, and for small teams that want their Figma system to stay the source of truth while AI writes the UI. You keep designing in Figma. Your agent gets exact components, tokens and rules instead of guessing from screenshots.

How it works

  1. Design in Figma. Build components the usual way, using the naming contract so exports stay predictable.
  2. Export with the plugin. The Frame-Relay plugin turns your file into a kit: component specs, design tokens, icons and screenshots as plain JSON and image files.
  3. Run sync. One command writes React + Tailwind components, token CSS, rule files for your AI, and MCP client configs into your project.
  4. Build with your AI agent. Your agent reads the kit through the MCP server, then builds screens that match the design. Rules files keep it from inventing raw buttons or hard-coded colors.

Live mode is the optional fifth step: pair Figma with your agent and let it read the layer you have selected. See Live mode. Export mode always works without it.

60-second quickstart

bash
# 1. Create a React + TypeScript app (Vite shown here; any React app works)npm create vite@latest my-app -- --template react-tscd my-app
# 2. Add Tailwind CSS v4npm install tailwindcss @tailwindcss/vite# Then add the tailwindcss() plugin to vite.config.ts and# `@import "tailwindcss";` to src/index.css.
# 3. In Figma: run the Frame-Relay plugin, open the Export tab, click Export Kit (.zip)
# 4. Set up Frame-Relay and sync the kitnpx @frame-relay/cli@beta init --yesnpx @frame-relay/cli@beta sync --from ~/Downloads/frame-relay-kit-my-file.zip
# 5. Check the setupnpx @frame-relay/cli@beta doctor

Open the folder in OpenCode (or your AI tool), then ask: "Build a settings page with the kit components." The agent calls the MCP server for the component list, props and tokens, and builds.

Getting the Figma plugin: Frame-Relay is coming to Figma Community. Until it is approved, open Figma desktop, go to Plugins, Development, Import plugin from manifest, and pick packages/plugin/manifest.json from this repo.

Full walkthrough: Getting started. Ideas first: Concepts.

Setup guide for designers

These steps are written for a designer who has never used a terminal. A terminal is a window where you type short commands to your computer. Your AI coding tool has one built in.

Part 1: Get ready (once)

Step 1. Install Node.js. Go to nodejs.org, download the LTS version, and install it like any other app. Why: Frame-Relay runs on Node.js. Without it, your computer can't run the commands below.

Step 2. Install an AI coding tool. Pick one: Cursor, Antigravity, OpenCode or Claude Code. Install it and sign in. Why: This is the AI that will build your app. Frame-Relay teaches it to use your designs.

Step 3. Add the Frame-Relay plugin to Figma. Open Figma, search for "Frame-Relay" in Community plugins, and click Install. Until the listing is live, download the plugin zip from the latest GitHub release and follow these import steps. Why: The plugin is how your designs leave Figma and reach your AI.

Part 2: In Figma

Step 4. Design your components. Build your buttons, inputs and cards as Figma components. Follow the simple naming rules in the naming contract, such as naming a variant "Size=Large" or "State=Hover", and use Figma variables for your colors and spacing. Why: Clear names let Frame-Relay understand your design. Variables let it carry your exact colors and sizes into code.

Step 5. Check your file. Run the Frame-Relay plugin and open the Lint tab. Click Check file. Fix anything it lists, then check again. Why: It's like spell-check for your design file. It catches problems before they turn into messy code.

Step 6. Export your kit. Open the Export tab and click Export kit. A zip file downloads. Why: This zip is your whole design system packed into one box: colors, sizes, components and a picture of each one.

Part 3: Set up your app

Step 7. Create a project folder. Make a new folder on your computer, for example my-app. Use dashes, not spaces, in the name. Open the folder in your AI tool. Why: Your app's code needs a home.

Step 8. Ask your AI to set up the app. Paste this into your AI tool:

text
Set up a Vite + React + TypeScript app in this folder, with Tailwind CSS v4 and the "@/" path alias pointing to src. Then run npm run build to confirm it works.

Why: This creates an empty app that Frame-Relay knows how to work with.

Step 9. Set up Frame-Relay. Open the terminal in your AI tool and type:

bash
npx @frame-relay/cli@beta init

Answer yes to its questions. Why: It looks at your app and gets it ready to receive your designs.

Step 10. Bring in your designs. Type this, with a space at the end:

bash
npx @frame-relay/cli@beta sync --from

Then drag your zip file from Step 6 into the terminal and press Enter. Why: This opens the box. It turns your Figma components into real code, and writes rules telling your AI: "Always use these. Never invent your own."

Step 11. Run a health check.

bash
npx @frame-relay/cli@beta doctor

You should see green ticks. Why: It's like the warning lights in a car. It confirms everything is connected before you start building.

Part 4: Build with your AI

Step 12. Ask your AI to build a screen. Start a new chat in your AI tool and ask for what you need, for example: "Build a login page using my design kit." Why: The AI now looks up your components before it builds, so it uses your buttons and inputs instead of making up its own.

Step 13. See your app. In the terminal, type:

bash
npm run dev

Open the link it shows, usually http://localhost:5173, in your browser. Why: You see the page the AI built and can compare it with your Figma design.

Step 14. Check the AI's work.

bash
npx @frame-relay/cli@beta check

Why: It catches any place the AI broke your rules, such as using a random color. If it finds something, ask the AI: "Fix the issues frame-relay check found."

Part 5: Extras

Step 15. Use live mode (optional). Ask your AI: "Start Frame-Relay live mode." It gives you a 6-digit code. In Figma, open the plugin's Live tab, type the code and click Connect. Now select anything in Figma and ask your AI: "Build something that matches my Figma selection." Why: Your AI sees what you select in Figma right away, so you can build from a design you haven't exported yet.

Step 16. When you change your designs. Repeat Steps 5, 6 and 10: check, export and sync again. Why: Your code stays matched to your latest Figma design. If you edited a generated component by hand, Frame-Relay keeps your edit and saves the new version beside it, so you never lose work.

Supported AI tools

sync writes the setup for each tool it finds, so the agent can start using the kit right away.

ToolWhat sync writes
Antigravity.agents/mcp_config.json and .agents/rules/frame-relay.md
OpenCodeopencode.json (merged, other keys kept) and AGENTS.md
Cursor.cursor/mcp.json and .cursor/rules/frame-relay.mdc
Claude Code.mcp.json and CLAUDE.md

Until the stable release, the package is published with the beta tag only. The simplest setup is to install it as a dev dependency once: npm install -D @frame-relay/cli@beta. Sync then writes a command that uses the local install, and the MCP server starts without changes.

Documentation

PageWhat it covers
Getting startedFirst-time walkthrough from an empty folder to an AI-built page.
ConceptsThe kit, sync, rules files, MCP, check, doctor and live mode.
CLI commandsEvery command, its flags and the files it writes.
Figma pluginThe Lint, Export and Live tabs, plus warnings and the icon rule.
Live modePairing, the Live tab, live tools, security and troubleshooting.
MCP serverThe 10 tools your agent calls, resources and client setup.
Kit formatFolder layout and every field in the kit JSON files.
ConverterHow Figma data maps to kit specs, including every warning code.
Figma naming contractThe naming rules that keep exports clean.
JSON schemasStable URLs for the manifest, tokens and component schemas.

The same docs are published at https://joseph-brendan.github.io/Frame-Relay/.

Contributing

Setup, commands, branch naming and release notes are in CONTRIBUTING.md. Security reports: SECURITY.md. What we collect: nothing, see PRIVACY.md.

License

MIT, copyright (c) 2026 Joseph Brendan.

来源:README.md,提交 f299e32

工具

0
SourceWeft 尚未在沙箱中启动过该软件包,因此其工具未知。

版本历史

1
  1. v0.1.0-beta.0最新Oct 9, 2026

评分

已满足适用检查项的 50%

该评分衡量此收录条目的完整程度,依据注册中心条目、端点与公开来源计算得出。它不是对服务器本身的评价,也不表示服务器安全或当前可用:可连通性是带日期的检查结果,评分也不包含安装量或用户评价。

  • 近 30 天内可连通25 分

    请保持端点能够响应 MCP 握手;SourceWeft 每 30 天探测一次。

  • 已声明认证方式10 分

    请在注册中心条目中声明凭据请求头,或保持端点能够响应探测,以便判定其认证方式。

  • 已列出工具15 分

    请让服务器在无凭据时响应 tools/list,或发布可在沙箱中无凭据启动的软件包。

  • 描述必需15 分
  • 图标10 分
  • 文档15 分
  • 许可证10 分