figma-mcp-server-with-chunking

🚀 Figma MCP 服务器带分块功能

本项目是一个与 Figma API 交互的 Model Context Protocol (MCP) 服务器，内置内存高效的分块和分页功能，能够有效处理大文件，极大提升了处理效率和内存利用率。

🚀 快速开始

此文档将详细介绍“带分块功能的 Figma MCP 服务器”（以下简称“服务器”）的使用方法，涵盖安装、配置、工具使用、内存管理等相关指南。

✨ 主要特性

• 与 Figma API 交互，实现数据获取与处理。
• 内置内存高效的分块和分页功能，适合处理大文件。
• 支持环境变量和配置文件两种配置方式。
• 提供多种工具，如获取文件数据和列出文件工具。
• 具备完善的内存管理策略和错误处理机制。

📦 安装指南

通过 Smithery 安装

# 使用以下命令安装：
figma-mcp-server --install

手动安装（可选）

# 克隆仓库：
git clone https://github.com/your-repository.git
cd figma-mcp-server

# 安装依赖：
npm install

# 启动服务器：
node index.js

📚 详细文档

配置指南

环境变量配置

设置以下环境变量以配置服务器行为：

• FIGMA_ACCESS_TOKEN：Figma 访问令牌
• MAX_MEMORY_MB：最大允许内存（单位：MB）
• DEFAULT_CHUNK_SIZE：默认分块大小（单位：节点）

配置文件加载

创建或修改 config.json 文件，添加以下内容：

{
  "accessToken": "your-figma-token",
  "maxMemory": 512,
  "chunkSize": 100
}

工具使用指南

获取文件数据工具 (get_file_data)

• 功能说明：
  • 输入：fileKey 和 accessToken
  • 输出：返回指定文件的数据分块，支持分页和筛选
• 使用示例：

# 请求参数：
{
  "tool": "get_file_data",
  "arguments": {
    "fileKey": "abc123",
    "nodeTypes": ["rectangle", "ellipse"]
  }
}

# 返回数据：
{
  "data": {
    "nodes": [ ... ],
    " pageInfo": { "hasNext": true, "cursor": "xyz456" }
  },
  "metadata": {
    "memoryUsage": 256,
    "responseTime": 500
  }
}

列出文件工具 (list_files)

• 功能说明：
  • 输入：accessToken
  • 输出：返回用户所有 Figma 文件列表
• 使用示例：

# 请求参数：
{
  "tool": "list_files",
  "arguments": {
    "accessToken": "your-figma-token"
  }
}

# 返回数据：
{
  "data": { "files": [...] },
  "metadata": {}
}

内存管理策略

• 分块处理：
  • 分块大小：默认 100 节点，可配置
  • 内存监控：实时跟踪使用情况
  • 自动调整：根据压力动态调节
  • 进度跟踪：每个分块都有详细日志

最佳实践

1. 初始建议：从小分块（50 - 100 节点）开始，逐步优化。
2. 监控内存使用情况，通过响应元数据查看。
3. 尽量使用节点类型筛选减少负载。
4. 大数据集时实施分页。
5. 使用续传功能处理大文件。

调试日志

示例输出

[MCP 调试] 从 config.json 加载配置
[MCP 调试] 找到访问令牌：xxxxxxx...
[MCP 调试] 请求 { tool: 'get_file_data', arguments: {...} }
[MCP 调试] 响应大小为 2.5 MB

错误处理

常见错误信息

• 内存限制： "响应过大。请尝试使用更小的深度值或指定 node_id。"
• 无效参数： "缺少必需参数：fileKey 和 accessToken"
• API 错误： "Figma API 错误：[详细信息]"

故障排除

常见问题

1. 内存错误：

• 减小分块大小
• 使用节点类型筛选
• 实施分页
• 指定较小的深度值

2. 性能问题：

• 监控内存使用情况
• 调整分块大小
• 使用适当的节点类型过滤器
• 实现频繁访问数据的缓存

3. API 限制：

• 实施速率限制
• 使用分页
• 在可能时进行响应缓存

调试模式启用

# 设置调试环境变量：
export DEBUG=true

📄 许可证

• 协议：MIT License

项目仓库

• 地址：https://github.com/your-repository.git

版本信息

• 版本：v1.0.0

⚠️ 重要提示

文档内容版权归作者所有，未经授权禁止转载或复制。