使用说明
Figma文档MCP服务器
MCP(模型上下文协议)服务器,为LLM代理和开发人员提供对Figma插件API文档和社区代码示例的即时访问。
这是什么
该服务器包含完整的Figma插件API文档,以及数百个来自开源插件的真实世界代码示例,所有这些都可以在本地搜索。它使LLM代理能够快速找到准确的API信息和工作代码模式,而不会出现错误或使用过时的信息。
为什么存在
编写Figma插件需要不断参考文档和工作示例。此服务器提供:
- 完整的Figma API官方文档(插件API、Widget API、REST API)
- 316个社区插件库,包含真实代码示例
- 所有内容均已索引并可通过语义理解进行搜索
- 即时本地访问,无需依赖互联网
- 麻省理工学院许可的代码示例已准备就绪
安装
git clone https://github.com/bbssppllvv/figma-mcp-server.git
cd figma-mcp-server
./setup.sh
设置OpenAI API密钥:
export OPENAI_API_KEY="your-key-here"
测试安装:
python -m src.mcp_server
# Should show: MCP server running on stdio
使用游标
- 复制
cursor-mcp-config.json到你的.cursor/mcp.json - 替换
/absolute/path/to/figma-mcp-server与你的实际路径 - 添加您的OpenAI API密钥
重要提示: 使用绝对路径,避免目录名中有空格。
配置示例:
{
"mcpServers": {
"figma-docs": {
"command": "/Users/yourname/figma-mcp-server/venv/bin/python",
"args": ["-m", "src.mcp_server"],
"cwd": "/Users/yourname/figma-mcp-server",
"env": {
"OPENAI_API_KEY": "sk-your-actual-api-key-here",
"PYTHONPATH": "/Users/yourname/figma-mcp-server"
}
}
}
}
可用工具
mcp搜索
搜索文档和代码示例:
"figma.createRectangle"
"how to save plugin data"
"ui.postMessage examples"
mcp扩展
从搜索结果中获取完整内容:
mcp_expand("result-id")
mcp健康
检查数据库状态和搜索功能
数据库内容
- 1014页文档
- 892个官方Figma API页面
- 316社区插件库
- 1841个代码示例块
- 3135个语义搜索嵌入
项目结构
figma-mcp-server/
├── src/
│ ├── mcp_server.py # Main MCP server
│ ├── search_engine.py # Search with semantic/keyword fallback
│ ├── expand_engine.py # Content expansion
│ ├── cross_linker.py # Links between docs and examples
│ └── preview_generator.py # Smart content previews
├── config/query_aliases.yaml # Search term mappings
├── meta.db # SQLite database (57MB)
├── requirements.txt # Python dependencies
└── setup.sh # Installation script
搜索功能
- 基于OpenAI嵌入的语义搜索
- 关键字搜索回退
- API符号自动检测
- 官方文档和社区示例之间的交叉引用
- 带有代码高亮显示的智能内容预览
需求
- Python 3.8+
- OpenAI API密钥
- SQLite(包括在内)
故障排除
问题:游标中出现“生成EACCES”错误
原因: 路径包含空格或特殊字符 解决方案: 将项目移动到没有空格的路径:
# If your path has spaces like "/Users/name/My Projects/figma-mcp-server"
# Move it to "/Users/name/figma-mcp-server"
mv "/Users/name/My Projects/figma-mcp-server" "/Users/name/figma-mcp-server"
问题:“数据库连接失败”
原因: 数据库路径配置不正确 解决方案: 在游标MCP配置中使用绝对路径:
{
"command": "/absolute/path/to/figma-mcp-server/venv/bin/python",
"cwd": "/absolute/path/to/figma-mcp-server",
"env": {
"PYTHONPATH": "/absolute/path/to/figma-mcp-server"
}
}
问题:OpenAI API密钥不工作
原因: API密钥无效或丢失 解决方案:
- 从获取新密钥https://platform.openai.com/api-keys
- 确保它从以下内容开始
sk- - 检查您的OpenAI帐户是否有信用
许可证
MIT许可证。所有社区代码示例都保持其原始的MIT许可证。
