Figma MCP Server

Figma MCP Server

site icon
2025.02.25 2
TypeScript设计工具文件分析开发效率
mcp-figma 是一个基于 Model Context Protocol (MCP) 的服务,专门用于分析 Figma 文件的结构。它提供了 REST API 和 MCP 协议两种交互方式,能够提取 Figma 文件的节点层次结构,并支持配置节点树的深度。
View on GitHub

Overview

基本能力

产品定位

mcp-figma 是一个专门用于分析 Figma 文件结构的 MCP 服务器,旨在帮助开发者或设计师更好地理解和操作 Figma 文件。

核心功能

  • 分析 Figma 文件:提取 Figma 文件的节点层次结构。
  • 支持多种协议:提供 REST API 和 MCP 协议两种交互方式。
  • 可配置的节点树深度:允许用户根据需要设置节点树的深度。

适用场景

  • 开发工具集成:将 Figma 文件分析功能集成到开发工具中。
  • 自动化设计流程:自动化处理 Figma 文件,提高设计效率。
  • 教育与研究:用于教学或研究 Figma 文件的结构和设计模式。

工具列表

  • REST API:提供标准的 RESTful 接口,方便与其他系统集成。
  • MCP 协议:支持通过 MCP 协议直接与 LLM 交互。
  • Docker 支持:提供容器化部署方案,便于在云环境中运行。

常见问题解答

  • 如何获取 Figma API Key:可以从 Figma 账户设置中获取 API Key。
  • 如何配置节点树深度:在请求中通过 depth 参数设置。

使用教程

使用依赖

  • Node.js 16+:确保已安装 Node.js 16 或更高版本。
  • npm 或 yarn:用于安装和管理依赖。
  • Figma API Key:需要有效的 Figma API Key。

安装教程

从 npm 安装

npm install -g figma-mcp-server

从源码安装

git clone https://github.com/yourusername/mcp-figma.git
cd mcp-figma
npm install
npm run build

配置

复制示例环境文件并添加 Figma API Key:

cp .env.example .env

编辑 .env 文件,添加 Figma API Key:

FIGMA_API_KEY=your_figma_api_key_here

调试方式

作为 REST API 服务器运行

npm start

作为 MCP 服务器运行

figma-mcp-server --cli

或从源码运行:

npm run start -- --cli

客户端示例

node client-example.js https://www.figma.com/file/FILE_ID/PROJECT_NAME?node-id=NODE_ID 2

开发模式

npm run dev

测试

npm test

Docker 部署

docker build -t figma-mcp-server .
docker run -p 3000:3000 --env-file .env figma-mcp-server

许可证

该项目遵循 MIT 开源许可条款,请参阅 MIT 了解完整条款。