Figma MCP Server 使用说明

项目简介

Figma MCP Server 是一个实现了 Model Context Protocol (MCP) 协议的服务器,它将 Figma API 封装成一系列 MCP 工具,使得大型语言模型 (LLM) 客户端可以通过 MCP 协议调用这些工具,从而实现对 Figma 设计文件的各种操作,例如读取文件信息、获取设计元素、管理评论等。

主要功能点

  • 全面的 Figma API 支持: 提供了几乎所有 Figma API 方法的工具封装,包括用户、文件、评论、团队项目、组件、样式、Webhook 和 Library Analytics 等功能模块。
  • 标准 MCP 协议: 完全遵循 MCP 协议规范,易于与任何兼容 MCP 协议的 LLM 客户端集成。
  • 工具化访问: 将 Figma API 的复杂操作抽象为易于理解和调用的 MCP 工具,降低了 LLM 使用 Figma API 的门槛。
  • 灵活的部署方式: 可以通过 Smithery 快速安装,也支持本地手动安装和配置,适应不同的使用场景。
  • 多种认证方式: 支持通过环境变量或命令行参数配置 Figma API Token,方便用户进行身份验证。

安装步骤

  1. 克隆仓库

    git clone https://github.com/JayArrowz/mcp-figma.git
    cd mcp-figma
  2. 安装依赖

    npm install
  3. 构建项目

    npm run build

服务器配置

要将 Figma MCP Server 集成到 MCP 客户端(例如 Claude Desktop),您需要配置服务器的启动命令和参数。以下是 Claude Desktop 'claude_desktop_config.json' 文件的配置示例,展示了如何配置 Figma MCP Server:

{
  "mcpServers": {
    "figma": {
      "command": "npx",
      "args": ["@jayarrowz/mcp-figma", "--figma-token", "YOUR_FIGMA_TOKEN"]
    }
  }
}

参数说明:

  • server name (figma): 自定义的服务名称,用于在 MCP 客户端中标识和调用该服务。
  • command (npx): 启动 MCP 服务器的命令。这里使用 'npx' 可以直接运行安装在 npm 中的 '@jayarrowz/mcp-figma' 包。
  • args: 传递给启动命令的参数列表。
    • '@jayarrowz/mcp-figma': 指定要运行的 npm 包,即 Figma MCP Server。
    • '--figma-token YOUR_FIGMA_TOKEN': Figma API 访问令牌。请务必将 'YOUR_FIGMA_TOKEN' 替换为您自己的 Figma API 令牌。 您也可以选择将 'FIGMA_API_KEY' 环境变量设置为您的 Figma API 令牌,这样可以省略 '--figma-token' 参数。

注意: 请确保您已安装 Node.js 和 npm,并已获取 Figma API 令牌。

基本使用方法

配置完成后,在 MCP 客户端中,您可以使用 'callTool' 函数调用 Figma MCP Server 提供的工具。工具名称以 'figma_' 开头,例如:

// 获取 Figma 文件信息
const fileInfo = await callTool("figma_get_file", { fileKey: "your_file_key" });

// 获取 Figma 文件评论
const comments = await callTool("figma_get_comments", { fileKey: "your_file_key" });

您可以参考仓库 README.md 文件中 "Tools" 部分,查看所有可用的 Figma API 工具及其参数说明。

信息

分类

AI与计算