Figma REST API

🚀 Figma Model Context Protocol (MCP) Server

The Figma MCP Server is a tool for interacting with Figma and supports integration with Claude. It offers powerful design collaboration capabilities and strict input validation.

🚀 Quick Start

The Figma MCP Server serves as an interactive tool with Figma, enabling seamless integration with Claude. Below is an overview of its core implementation and features:

• Core Implementation: Facilitates in - depth integration with Figma, offering robust design collaboration capabilities.
• Claude Desktop Integration: Enables seamless connection with the Claude desktop client.
• Tool Validation: All tool inputs undergo strict validation.
• Error Handling: Provides detailed error information and status codes.

✨ Features

Core Features

• Security Authentication: Currently supports only personal access tokens, with OAuth planned for the future.
• Rate Limiting: Adheres to the rate - limiting specifications of the Figma API.
• Cache Management: The default cache TTL is 5 minutes, and the maximum number of cache entries is 500.
• Module Resolution: Supports both local and global module resolutions.

Tool Validation

All tool inputs are strictly validated using 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'])
  }))
});

📦 Installation

Installation Steps

1. Clone the Repository: Use Git to clone the project.
2. Build the Project: Run npm run build to compile TypeScript files.
3. Set Environment Variables: Configure the necessary environment variables.
4. Start the Server: Execute node dist/index.js to start the MCP server.

Configuration Example

# Install dependencies
npm install

# Compile the project
npm run build

# Start the server
node dist/index.js --port 3000 --env development

💻 Usage Examples

Core API

• Start the MCP Server

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

Tool Validation Scheme

All tools use Zod for input validation to ensure data correctness.

📚 Documentation

Project Status

Completed Features

1. Core Implementation
   • Initialize and start the MCP server.
   • Support data interaction with Figma.
   • Integrate the Claude desktop client.
   • Provide a comprehensive error - handling mechanism.

Potential Features

• Implement team - level permission management.
• Support OAuth authentication.
• Develop more design collaboration tools.

Error Handling

Common Error Codes

• 403 Forbidden: Authentication failed or invalid token.
• 429 Too Many Requests: Rate limit exceeded.
• 400 Bad Request: Parameter validation failed.
• 500 Internal Server Error: Server internal error.

Known Issues and Limitations

API Limitations

1. Read - only Operations: The current version only supports read operations.
2. Token Permissions: Personal access tokens do not have write permissions.
3. Cache Policy: The default cache TTL is 5 minutes, and the capacity limit is 500 items.

Contribution Guidelines

1. Fork the Repository: Create your own copy of the codebase.
2. Create a Feature Branch: Create a separate branch for new features or bug fixes.
3. Submit Changes: Ensure that detailed test cases are included.
4. Submit a Pull Request: Merge into the main branch.

Development Specifications

• Follow the TypeScript strict mode.
• Use ESLint for code inspection.
• Adopt Jest for unit testing.
• Implement a comprehensive error - handling mechanism.

Troubleshooting

For more debugging steps and solutions, refer to the Troubleshooting Guide.

Common Issues

1. JSON Connection Error

   • Ensure that an absolute path is used in the Claude desktop configuration.
   • Confirm that the server has been successfully built (dist/index.js).
   • Verify that all environment variables are correctly set.

2. Authentication Failure

   • Check if the token is valid and not expired.
   • Ensure that the token has the required permissions.

📄 License

This project is licensed under the MIT License. For detailed information, please refer to the LICENSE file.

💡 Usage Tip

If you need feedback or technical support, please contact the project maintainers.