🚀 Figma MCP 服务器

Figma MCP 服务器是一个与 Figma API 集成的 Model Context Protocol (MCP) 服务器，它能让您与 Figma 文件、评论、组件等进行交互，为您在 Figma 平台上的操作提供便利。

🚀 快速开始

本服务器可帮助您轻松实现与 Figma API 的交互，按以下步骤操作即可开启使用。

✨ 主要特性

• 文件操作
  • 获取文件信息，助您快速了解文件概况。
  • 获取文件版本历史，方便追溯文件的变更过程。
  • 获取文件组件，便于对组件进行管理和使用。
• 评论管理
  • 列出文件中的评论，让您清晰掌握文件的讨论情况。
  • 添加新评论，方便团队成员交流想法。
  • 删除评论，可清理不必要的信息。
• 项目与团队功能
  • 列出团队的项目，使团队项目一目了然。
  • 获取项目的文件，便于对项目文件进行操作。
  • 获取已发布的样式，统一团队的设计风格。
• 网钩管理
  • 创建网钩，实现特定事件的自动化触发。
  • 列出现有的网钩，方便对网钩进行管理。
  • 删除网钩，可停用不再需要的自动化功能。

📦 安装指南

1. 克隆仓库。
2. 安装依赖：

npm install

3. 构建服务器：

npm run build

📚 详细文档

配置

在您的 MCP 设置文件中配置服务器，使用 Figma 访问令牌：

{
  "mcpServers": {
    "figma": {
      "command": "node",
      "args": ["path/to/figma-server/build/index.js"],
      "env": {
        "FIGMA_ACCESS_TOKEN": "your-access-token-here"
      },
      "disabled": false,
      "alwaysAllow": []
    }
  }
}

可用工具

文件操作

• get_file：获取文件信息

{
  "file_key": "string"
}

• get_file_versions：获取文件版本历史

{
  "file_key": "string"
}

• get_file_components：获取文件中的组件

{
  "file_key": "string"
}

评论管理

• get_file_comments：获取文件中的评论

{
  "file_key": "string"
}

• post_comment：在文件中添加评论

{
  "file_key": "string",
  "message": "string"
}

• delete_comment：删除文件中的评论

{
  "file_key": "string",
  "comment_id": "string"
}

项目与团队功能

• get_team_projects：获取团队的项目

{
  "team_id": "string"
}

• get_project_files：获取项目的文件

{
  "project_id": "string"
}

• get_component_styles：获取已发布的样式

{
  "team_id": "string"
}

网钩管理

• create_webhook：创建网钩

{
  "team_id": "string",
  "event_type": "string",
  "callback_url": "string"
}

• get_webhooks：列出网钩

{
  "team_id": "string"
}

• delete_webhook：删除网钩

{
  "webhook_id": "string"
}

💻 使用示例

基础用法

// 示例：使用 MCP 工具获取文件信息
<use_mcp_tool>
<server_name>figma</server_name>
<tool_name>get_file</tool_name>
<arguments>
{
  "file_key": "your-file-key"
}
</arguments>
</use_mcp_tool>

📄 许可证

本项目采用 MIT 许可证。

🤝 贡献指南

如果您想为项目做出贡献，请按以下步骤操作：

1. 叉仓库。
2. 创建功能分支。
3. 提交更改。
4. 推送到分支。
5. 创建新的 Pull Request。