Figma MCP服务器
英语: README.en.md | 中文: README.zh-CN.md
 
🌍 Language Selection / 语言选择
🇺🇸 英语
有关英文文档,请访问: README.en.md
🇨🇳 中文
对于中文文档,请访问:README.zh-CN.md
______________________________________________________________________
🚀 Quick Overview / 快速概览
专为以下目的设计的专用MCP服务器 开发者 系统地提取和组织Figma设计文件 页面级别.
一个专门为程序员设计的MCP服务器,用于系统性地按页面级别提取和组织Figma设计文件。
🎯 主要功能:完成节点数据提取 / 主要功能:完整节点数据提取
get_complete_node_data⭐ 主要工具 / 主要工具
获取完整的节点数据(树结构+图像)并组织到文件夹中
获取完整的节点数据(树结构 + 图片)并组织到文件夹中
Workflow / 工作流程:
graph TD
A[Input: file_key + node_ids] --> B[Extract Tree Structure]
B --> C[Get Node Names]
C --> D[Download Images]
D --> E[Organize Files to Folder]
E --> F[Create Summary Info]
F --> G[Output Complete Data Package]- Parameters / 参数:
- file_key: Figma file unique identifier / Figma 文件唯一标识符 - node_ids: Node IDs, comma-separated / 节点 ID,逗号分隔 - image_format: Image format (default: png) / 图片格式(默认:png) - image_scale: Image scale factor (default: 1.0) / 图片缩放因子(默认:1.0) - tree_depth: Tree depth (default: 4) / 树深度(默认:4)
Output Structure / 输出结构:
your_node_name_your_node_id_here/
├── nodesinfo.json # Complete tree structure data (core) / 完整树结构数据(核心)
└── your_node_id_here.png # Downloaded image file / 下载的图片文件🧠 为什么这种AI理解结构 / 为什么这种结构适合 AI 理解
这种输出结构是专门为帮助AI全面理解设计而设计的:
这种输出结构专门设计用于帮助 AI 全面理解设计:
多模态信息融合 / 多模态信息融合
- 结构化数据 (
nodesinfo.json):包含精确的定位、样式、约束和层次关系 - 结构化数据 (
nodesinfo.json): 包含精确的定位、样式、约束和层次关系 - 可视化数据 (
.png):为视觉验证提供实际渲染外观 - 视觉数据 (
.png): 提供实际渲染外观用于视觉验证 - 上下文信息:文件命名和组织提供设计上下文
- 上下文信息: 文件命名和组织提供设计上下文
AI友好设计 / AI 友好设计
- 完整上下文:AI可以理解逻辑结构和视觉外观
- 完整上下文: AI 可以理解逻辑结构和视觉外观
- 关系清晰度:明确定义了层次关系和约束
- 关系清晰: 层次关系和约束被明确定义
- 可解析格式JSON结构使AI能够轻松提取和处理信息
- 可解析格式: JSON 结构允许 AI 轻松提取和处理信息
现实世界中的AI用例 / 实际 AI 使用场景
- 设计分析:“此页面有12个框架,18个文本元素,使用白色背景…”
- 设计分析: "此页面有 12 个框架,18 个文本元素,使用白色背景..."
- 代码生成:“根据布局约束,生成宽度为375px的React组件…”
- 代码生成: "基于布局约束,生成宽度为 375px 的 React 组件..."
- 设计建议:“检测到45个节点,考虑组件化以降低复杂性…”
- 设计建议: "检测到 45 个节点,考虑组件化以减少复杂性..."
- 响应式适应:“页眉使用SCALE约束,需要移动布局调整…”
- 响应式适配: "头部使用 SCALE 约束,需要移动端布局调整..."
优化结构 / 优化结构
- 仅为必需:仅包含对AI理解最重要的文件
- 仅包含必要: 仅包含 AI 理解所需的最重要文件
- 高效数据:紧凑的输出结构,同时保留所有必要的信息
- 高效数据: 紧凑的输出结构,同时保持所有必要信息
- 成本效益高:最大限度地减少API令牌的使用,同时最大限度地提高对人工智能的理解
- 成本效益: 最小化 API 令牌使用,同时最大化 AI 理解
✨ Key Features / 主要功能
- 📋 节点列表 (
list_nodes_depth2) / 节点列表 - 🔍 树结构提取 (
extract_figma_tree) / 树结构提取 - 🖼️ 图像下载 (
download_figma_images) / 图片下载 - 🔧 完成数据导出 (
get_complete_node_data) / 完整数据导出 - 🖼️ 帧提取 (
extract_frame_nodes) / 框架提取 - 🌐 跨平台 / 跨平台支持
- 💡 AI优化结构 / AI优化结构
🛠️ Quick Installation / 快速安装
选项1:从PyPI安装(推荐)/从 PyPI 安装(推荐)
pip install figma-mcp-tools选项2:从源代码安装/从源码安装
# Clone the repository
git clone https://github.com/DRX-1877/figma-mcp-server.git
cd figma-mcp-server
# Run installation script (automatically configures environment)
./install.sh # macOS/Linux
# or
install.bat # Windows就是这样! 安装后,该命令将在全球范围内可用。
就这么简单! 安装后命令即可全局使用。
🌍 Global Command Availability / 全局命令可用性
安装后 figma-mcp-tools 命令将可用 全球范围内 从任何目录:
安装完成后,figma-mcp-tools 命令将在任何目录中全局可用:
macOS/Linux
# Use from any directory
figma-mcp-tools --help
# If command is not available, run the fix script
./fix-command.sh
# Or manually reload shell configuration
source ~/.zshrc # for zsh
# or
source ~/.bashrc # for bash视窗
# Use from any directory
figma-mcp-tools --help
# If command is not available, run the fix script
fix-command.bat
# Or reopen command prompt to reload environment variables🔧 自动环境配置/自动环境配置
安装脚本会自动配置您的环境:
安装脚本会自动配置您的环境:
- PATH配置:将虚拟环境和本地bin目录添加到PATH
- PATH 配置: 自动将虚拟环境和本地 bin 目录添加到 PATH
- 全球Symlinks:在系统目录中创建符号链接
- 全局符号链接: 在系统目录中创建符号链接
- 壳牌集成:更新shell配置文件(.zshrc、.bashrc)
- Shell 集成: 更新 shell 配置文件 (.zshrc, .bashrc)
无需手动配置! 🎉
无需手动配置! 🎉
🔍 Troubleshooting / 故障排除
如果安装后该命令不可用:
如果安装后命令不可用:
macOS/Linux
# Option 1: Run the fix script
./fix-command.sh
# Option 2: Manually reload shell configuration
source ~/.zshrc # for zsh
# or
source ~/.bashrc # for bash
# Option 3: Open a new terminal window视窗
# Option 1: Run the fix script
fix-command.bat
# Option 2: Reopen command prompt
# Option 3: Restart computer📚 Documentation / 文档
______________________________________________________________________
📖 Choose Your Language / 选择您的语言
🇺🇸 英文文档
完整的英文文档,包括详细的安装说明、使用示例和API参考资料。
🇨🇳 中文文档
完整的中文文档,包含详细的安装说明、使用示例和API参考。
