sketch-mcp-server
Provides tools for analyzing Sketch design files, extracting nodes, styles, hierarchies, and generating code, with smart token optimization and support for symbol components and visual rendering.
Click on "Deploy Server".
Wait a few minutes for the server to deploy. Once ready, it will show a "Started" state.
In the chat, type
@followed by the MCP server name and your instructions, e.g., "@sketch-mcp-server Load the Sketch file at /path/to/file.sketch and give me a summary of nodes"
That's it! The server will respond to your query, and you can continue using it as needed.
Here is a step-by-step guide with screenshots.
Sketch MCP Server
English | 中文
A Sketch file processing server based on Model Context Protocol (MCP), designed for AI tools to intelligently analyze Sketch design files and generate code.
✨ Core Features
🎨 Sketch File Analysis: Comprehensive parsing of Sketch files, extracting nodes, styles, hierarchies, and complete information
🚀 Smart Token Optimization: Up to 90% token consumption reduction, significantly lowering AI call costs
🔍 Intelligent Query System: 16 professional tools for efficient discovery and analysis of design elements
🎯 Symbol Component Support: Complete Symbol Master and Instance processing capabilities
🖼️ Visual Rendering: Render design nodes as SVG/PNG images for AI analysis
📊 Detailed Statistical Analysis: Comprehensive statistics for documents and nodes
🔧 CLI Tool Support: Support for direct npx calls without installation
Related MCP server: Sketch MCP
📦 Installation
Global Installation (Recommended)
npm install -g sketch-mcp-serverUsing npx (No Installation Required)
npx sketch-mcp-serverLocal Project Installation
npm install sketch-mcp-server🚀 Quick Start
Command Line Launch
# Start MCP server (stdio mode)
sketch-mcp-server
# Or use npx
npx sketch-mcp-serverAI Tool Integration
This server is designed for the following AI development environments:
Trae AI: As an MCP server for Sketch file analysis
Cursor: Configure as MCP tool for design-to-code workflow
Claude Desktop: For Sketch file processing and analysis
Trae AI Configuration Example
Add MCP server configuration in Trae AI:
{
"mcpServers": {
"sketch-mcp-server": {
"command": "npx",
"args": ["sketch-mcp-server"]
}
}
}🛠️ Tool List
📁 File Loading Tools
Tool Name | Description |
| Load Sketch file from file system |
| Load Sketch data from configuration object |
📊 Document Structure Tools
Tool Name | Description | Optimization Features |
| Get complete document hierarchy | 🚀 Supports field filtering and summary mode |
| Get single page structure | - |
| List all page basic information | - |
🎯 Node Query Tools
Tool Name | Description | Token Optimization |
| Smart Node Summary | 🔥 80-90% Token Reduction |
| List nodes (with filtering support) | - |
| List nodes by page | - |
| Search nodes by name | - |
🔍 Detailed Information Tools
Tool Name | Description |
| Get detailed information for single node |
| Batch get node information (up to 100) |
| Get node position information |
🔄 Symbol Component Tools
Tool Name | Description |
| Get all Symbol Masters |
| Get all Symbol Instances |
| Find Master by Symbol ID |
| Get instance styles (including override styles) |
🎨 Visualization Tools
Tool Name | Description |
| Render node as image (SVG/PNG) |
💡 Token Optimization Strategy
Data Volume Comparison
Tool/Mode | Token Reduction | Use Case |
| 80-90% | Initial analysis, understanding overall structure |
| 70-85% | Quick document structure overview |
| 30-50% | Structural analysis |
Full mode | 0% | Detailed design requirements |
Recommended Workflow
🔍 Quick Analysis: Use
getNodesSummaryto understand overall design structure📋 Structure Analysis: Use field-filtered
getDocumentStructureto get hierarchical relationships🎯 Detailed Information: Get detailed information for specific nodes as needed
👁️ Visual Verification: Render key components to confirm effects
📝 Usage Examples
Basic Workflow
// 1. Load Sketch file
{
"name": "loadSketchByPath",
"arguments": {
"path": "/path/to/design.sketch"
}
}
// 2. Get smart summary (save 80-90% tokens)
{
"name": "getNodesSummary",
"arguments": {
"groupBy": "type",
"includeStats": true,
"maxSamples": 5
}
}
// 3. Get detailed information for specific nodes
{
"name": "getMultipleNodeInfo",
"arguments": {
"nodeIds": ["button-id", "text-id"]
}
}
// 4. Render node as image
{
"name": "renderNodeAsBase64",
"arguments": {
"nodeId": "button-id",
"format": "svg"
}
}Advanced Optimization Examples
// Use field filtering to reduce data volume
{
"name": "getDocumentStructure",
"arguments": {
"fields": ["id", "name", "type", "children"],
"maxDepth": 3,
"summaryMode": false
}
}
// Smart summary grouped by style
{
"name": "getNodesSummary",
"arguments": {
"groupBy": "style",
"includeStats": true,
"maxSamples": 3
}
}🎯 Tool Selection Guide
Use Case | Recommended Tool | Token Efficiency | Description |
Understanding overall structure |
| ⭐⭐⭐⭐⭐ | Most efficient overview method |
Analyzing page hierarchy |
| ⭐⭐⭐⭐ | Structured hierarchical information |
Finding specific nodes |
| ⭐⭐⭐ | Precise search |
Getting detailed information |
| ⭐⭐ | Batch retrieval |
Handling Symbol components |
| ⭐⭐⭐ | Component-based design |
Visual confirmation |
| ⭐⭐ | Intuitive effect viewing |
🔧 Development Guide
Environment Requirements
Node.js >= 16.0.0
npm or yarn
Local Development
# Clone project
git clone https://github.com/mater1996/sketch-mcp-server.git
cd sketch-mcp-server
# Install dependencies
npm install
# Build project
npm run build
# Run tests
npm test
# Start development server
npm run start:mcpAvailable Scripts
npm run build # Build TypeScript to JavaScript
npm run test # Run test suite
npm run test:coverage # Run tests and generate coverage report
npm run start # Start HTTP server
npm run start:mcp # Start MCP stdio server
npm run release # Release new version
npm run release:dry # Simulate release process📚 API Reference
For detailed API documentation, please refer to Tool Usage Guide.
Development Standards
Write code in TypeScript
Follow existing code style
Add tests for new features
Update relevant documentation
📄 License
MIT License
🤝 Contributing
Contributions are welcome! Please feel free to submit a Pull Request.
📞 Support
If you encounter any issues or have questions, please:
Check the documentation
Search existing issues
Create a new issue if needed
Available Tools
17 toolsfindNodesByNameC
Find nodes by name pattern
Inputs: name (required), limit.
getDocumentStructureB
Get complete document structure with all pages and their hierarchies
Inputs: includeDetails, maxNodesPerPage, fields, excludeFields, +3 more.
getMultipleNodeInfoB
Get detailed information for multiple nodes by their IDs in a single call
Inputs: nodeIds (required).
getNodeInfoB
Get detailed information about a node by its ID
Inputs: nodeId (required).
getNodePositionB
Get the position of a node by its ID
Inputs: nodeId (required).
getNodesSummaryA
Get summary of nodes with statistics and grouping to reduce token usage
Inputs: pageId, groupBy, includeStats, maxSamples.
getPageStructureB
Get complete hierarchical structure of a page with all node information
Inputs: pageId (required), includeDetails, maxDepth.
getSymbolInstancesA
Get all Symbol Instances in the Sketch document
Inputs: no named parameters.
getSymbolInstanceStylesA
Get styles from Symbol Instance including overrides applied to Symbol Master
Inputs: instanceId (required).
getSymbolMasterBySymbolIDC
Get Symbol Master by its Symbol ID
Inputs: symbolID (required).
getSymbolMastersA
Get all Symbol Masters in the Sketch document
Inputs: no named parameters.
listNodesC
List nodes with optional filtering
Inputs: type, limit, offset.
listNodesByPageA
List nodes within a specific page
Inputs: pageId (required), limit, type, nameContains, +1 more.
listPagesC
List all pages in the Sketch document
Inputs: no named parameters.
loadSketchByConfigC
Load a Sketch configuration object
Inputs: cfg (required).
loadSketchByPathC
Load a Sketch file from a file path
Inputs: path (required).
renderNodeAsBase64B
Render a node as Base64 encoded image (SVG format) for AI to visualize the actual appearance
Inputs: nodeId (required), format.
Tool Schema Changelog
Recent tool additions, removals, and schema changes observed during successful MCP inspections.
Loading tool schema changelog…
TDQS
Scored across 17 tools
Each tool targets a distinct aspect of a Sketch document: loading files, browsing structure, querying nodes individually or in bulk, searching by name, listing with filters, and handling symbols. Boundaries between tools like getNodeInfo, getMultipleNodeInfo, and getNodesSummary are clear due to scope differentiation.
All tools follow a consistent verb_noun pattern (e.g., getNodeInfo, listPages, loadSketchByPath). Variations like 'find' for search are appropriate and maintain the overall pattern. No mixing of conventions.
17 tools is a well-scoped number for a Sketch document server, covering loading, querying, browsing, and rendering without being overwhelming. Each tool serves a clear purpose.
The tool surface covers core read operations: loading files, exploring pages/nodes, searching, symbol management, and rendering. Minor omissions like shared styles or advanced filtering exist, but the set is functionally complete for typical query tasks.
Maintenance
Related MCP Connectors
The Figma MCP server brings Figma design context directly into your AI workflow.
MCP server for AI agent profiles and smart notes. 60+ coding prompt packs with expert personas.
Zero-log MCP server with 49 tools for AI guardrails, secret scanning, MCP linting & EU compliance.
Free, no-key MCP server: token estimates, JSON Schema conversion, MCP configs, tool search.
Related MCP Servers
- AlicenseNot gradedqualityNot gradedmaintenanceAn automated MCP server for Google Stitch that enables AI-driven UI design generation, screen management, and design system extraction. It provides 19 professional tools for creating consistent web interfaces, conducting accessibility audits, and exporting design tokens.-

Sketch MCPofficial
AlicenseBqualityDmaintenanceAn official MCP server that allows AI clients to interact with Sketch designs, enabling exploration, iteration, asset export, and more.2MIT- AlicenseAqualityDmaintenanceMCP server that gives LLMs deep knowledge of design systems and tokens, enabling intelligent design evolution, token analysis, and designer-to-developer handoffs.3718 npm2MIT
- FlicenseNot gradedqualityCmaintenanceMCP server that parses .sketch design files into CSS-aligned, LLM-friendly JSON, enabling AI coding agents to generate high-fidelity HTML, Vue, or React code.-