项目简介

Figma MCP Server with Chunking 是一个基于 Model Context Protocol (MCP) 构建的服务器,旨在帮助大型语言模型 (LLM) 应用高效地访问和处理 Figma 设计文件数据。该服务器通过分块 (Chunking) 和分页 (Pagination) 技术,优化了处理大型 Figma 文件时的内存使用,避免因数据量过大而导致程序崩溃。

主要功能点

  • Figma 数据访问: 提供多种工具,用于获取 Figma 文件的各种信息,包括文件节点数据、组件、样式、版本历史和评论等。
  • 内存高效处理: 通过分块和分页技术,服务器能够处理大型 Figma 文件,而不会消耗过多内存。
  • 可配置的参数: 允许用户配置分块大小、内存限制、节点类型过滤等参数,以满足不同的数据处理需求。
  • 详细的调试日志: 提供全面的调试日志,帮助用户追踪服务器运行状态和排查问题。
  • 错误处理: 具备完善的错误处理机制,能够提供清晰的错误信息和建议。

安装步骤

  1. 克隆仓库:

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

    npm install
  3. 构建项目:

    npm run build

服务器配置

MCP客户端需要配置以下信息以连接到 Figma MCP Server:

{
  "servers": [
    {
      "name": "figma",
      "command": "node",
      "args": ["build/index.js"],
      "description": "Figma MCP Server with Chunking"
    }
  ]
}

配置参数说明:

  • 'name': 服务器名称,可以自定义,例如 "figma"。
  • 'command': 启动服务器的命令,这里使用 'node' 运行 JavaScript 代码。
  • 'args': 传递给 'node' 命令的参数,'build/index.js' 是编译后的服务器入口文件。

Figma API 访问令牌 (FIGMA_ACCESS_TOKEN):

此服务器需要 Figma API 访问令牌才能与 Figma API 交互。您可以通过以下两种方式配置访问令牌:

方法一: 环境变量

将 Figma API 访问令牌设置为名为 'FIGMA_ACCESS_TOKEN' 的环境变量。

方法二: 配置文件

创建一个 JSON 配置文件(例如 'config.json'),内容如下:

{
  "mcpServers": {
    "figma": {
      "env": {
        "FIGMA_ACCESS_TOKEN": "your-access-token"  // 替换为您的 Figma API 访问令牌
      }
    }
  }
}

然后在启动服务器时使用 '--config' 参数指定配置文件路径:

node build/index.js --config=path/to/config.json

基本使用方法

  1. 启动 MCP 服务器: 根据上述服务器配置和 Figma API 访问令牌配置,启动 Figma MCP Server。

  2. 配置 MCP 客户端: 在您的 MCP 客户端应用中,配置连接到名为 "figma" 的 MCP 服务器。客户端将通过标准输入/输出 (stdio) 与服务器通信。

  3. 调用工具: 通过 MCP 客户端,您可以调用服务器提供的工具来访问 Figma 数据。例如,使用 'get_file_data' 工具获取 Figma 文件数据:

    {
      "tool": "get_file_data",
      "arguments": {
        "file_key": "YOUR_FIGMA_FILE_KEY",  // 替换为您的 Figma 文件 Key
        "pageSize": 100,                    // 可选: 每页节点数量
        "maxMemoryMB": 512,                 // 可选: 最大内存限制 (MB)
        "nodeTypes": ["FRAME", "COMPONENT"]   // 可选: 节点类型过滤
      }
    }

    服务器将返回包含 Figma 文件数据的 JSON 响应。您可以参考仓库 README.md 文件中 "Tools" 部分,了解其他可用工具及其参数。

注意: 请确保您的 MCP 客户端已正确配置并连接到 Figma MCP Server,并且您已提供有效的 Figma API 访问令牌。

信息

分类

开发者工具