Figma REST API

🚀 Figma 模型上下文協議 (MCP) 服務器

Figma MCP 服務器是一款用於與 Figma 進行交互的工具，支持與 Claude 集成。它能實現與 Figma 的深度集成，提供強大的設計協作能力，還能與 Claude 桌面端無縫連接，且所有工具輸入都經過嚴格驗證，同時提供詳細的錯誤信息和狀態碼。

🚀 快速開始

Figma MCP 服務器可助力用戶與 Figma 進行交互，並集成 Claude。下面為你介紹其核心實現和功能：

• 核心實現：支持與 Figma 的深度集成，提供強大的設計協作能力。
• Claude 桌面集成：實現與 Claude 桌面端的無縫連接。
• 工具驗證：所有工具輸入均經過嚴格驗證。
• 錯誤處理：提供詳細的錯誤信息和狀態碼。

✨ 主要特性

核心功能

• 安全認證：僅支持個人訪問令牌，未來計劃實現 OAuth。
• 速率限制：遵循 Figma API 的速率限制規範。
• 緩存管理：默認緩存 TTL 為 5 分鐘，最大緩存條目數為 500。
• 模塊解析：支持本地和全局模塊分辨率。

工具驗證

所有工具輸入均使用 Zod 進行嚴格驗證：

const CreateVariablesSchema = z.object({
  fileKey: z.string(),
  variables: z.array(z.object({
    name: z.string(),
    type: z.enum(['COLOR', 'FLOAT', 'STRING']),
    value: z.string(),
    scope: z.enum(['LOCAL', 'ALL_FRAMES'])
  }))
});

📦 安裝指南

安裝步驟

1. 克隆倉庫：使用 Git 克隆項目。
2. 構建項目：運行 npm run build 構建 TypeScript 文件。
3. 設置環境變量：配置必要的環境變量。
4. 啟動服務器：執行 node dist/index.js 啟動 MCP 服務器。

配置示例

# 安裝依賴
npm install

# 編譯項目
npm run build

# 啟動服務器
node dist/index.js --port 3000 --env development

💻 使用示例

基礎用法

核心 API

• 啟動 MCP 服務器

const server = await startMCPServer({
  port: 3000,
  env: 'development',
  debug: true
});

高級用法

所有工具均使用 Zod 進行輸入驗證，確保數據正確性。如工具驗證部分的代碼示例，使用 Zod 對創建變量的輸入進行了嚴格驗證。

📚 詳細文檔

項目狀態

已完成的功能

1. 核心實現
   • 初始化並啟動 MCP 服務器。
   • 支持與 Figma 的數據交互。
   • 集成 Claude 桌面端。
   • 提供全面的錯誤處理機制。
2. 潛在功能
   • 實現團隊級權限管理。
   • 支持 OAuth 認證。
   • 開發更多設計協作工具。

錯誤處理

常見錯誤碼

• 403 Forbidden：認證失敗或無效令牌。
• 429 Too Many Requests：速率限制 exceeded。
• 400 Bad Request：參數驗證失敗。
• 500 Internal Server Error：服務器內部錯誤。

已知問題與限制

API 限制

1. 只讀操作：當前版本僅支持讀取操作。
2. 令牌權限：個人訪問令牌無寫入權限。
3. 緩存策略：默認緩存 TTL 為 5 分鐘，容量上限為 500 項。

貢獻指南

1. Fork 倉庫：創建自己的代碼庫副本。
2. 創建功能分支：為新功能或修復創建獨立分支。
3. 提交更改：確保包含詳盡的測試用例。
4. 提交 Pull Request：合併到主分支。

開發規範

• 遵循 TypeScript 嚴格模式。
• 使用 ESLint 進行代碼檢查。
• 採用 Jest 進行單元測試。
• 實現全面的錯誤處理機制。

故障排除

如需更多調試步驟和解決方案，請參閱 故障排除指南。

常見問題

1. JSON 連接錯誤
   • 確保在 Claude 桌面配置中使用絕對路徑。
   • 確認服務器已成功構建 (dist/index.js)。
   • 驗證所有環境變量均已正確設置。
2. 認證失敗
   • 檢查令牌是否有效且未過期。
   • 確保令牌具備所需權限。

聯繫方式

如需反饋或技術支持，請聯繫項目維護者。

📄 許可證

本項目遵循 MIT 許可證，具體內容詳見 LICENSE 文件。