使用说明
Figma MCP服务器
用于分析Figma文件结构的MCP(模型上下文协议)服务器。
特性
- 分析Figma文件以提取节点层次结构
- 支持REST API和MCP协议
- 可配置的节点树深度
先决条件
- Node.js 16+
- npm或纱线
- A Figma API密钥
安装
来自npm
npm install -g figma-mcp-server
来源
git clone https://github.com/yourusername/mcp-figma.git
cd mcp-figma
npm install
npm run build
配置
复制示例环境文件并添加Figma API密钥:
cp .env.example .env
然后编辑 .env 文件并添加您的Figma API密钥:
FIGMA_API_KEY=your_figma_api_key_here
您可以从Figma帐户设置中获取Figma API密钥:https://www.figma.com/developers/api#access-代币
用法
作为REST API服务器
启动服务器:
npm start
这将在端口3000(或您的 .env 文件)。
API终点
GET /health-健康检查端点GET /openapi.json-OpenAPI规范GET /mcp.json-MCP清单POST /analyze-分析Figma文件
对分析端点的请求示例:
curl -X POST http://localhost:3000/analyze \
-H "Content-Type: application/json" \
-d '{"figmaUrl": "https://www.figma.com/file/FILE_ID/PROJECT_NAME?node-id=NODE_ID", "depth": 2}'
作为MCP服务器
LLM可以通过MCP协议直接使用服务器:
figma-mcp-server --cli
或者,如果从源代码运行:
npm run start -- --cli
客户端示例
其中包括一个简单的客户端示例。要使用它:
node client-example.js https://www.figma.com/file/FILE_ID/PROJECT_NAME?node-id=NODE_ID 2
最后一个参数是可选的深度参数。
发展
以开发模式运行
npm run dev
测试
npm test
码头工人
Docker文件用于容器化部署:
docker build -t figma-mcp-server .
docker run -p 3000:3000 --env-file .env figma-mcp-server
许可证
麻省理工学院