KwiTsukasa/figma-local-context-mcp
1
0
Fork 0
mirror of https://github.com/KwiTsukasa/figma-local-context-mcp.git synced 2026-05-27 16:45:46 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

docs: sanitize README examples

Browse Source
This commit is contained in:
sunlei 2026-05-20 19:17:05 +08:00
parent 7c510c737c
commit e249b5d652
1 changed files with 20 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

40
README.md
View File

@ -12,7 +12,7 @@
- `list_fig_nodes`：按名称、类型或 node-id 搜索节点。 - `list_fig_nodes`：按名称、类型或 node-id 搜索节点。
- `get_design_tokens`：从全文件或指定节点子树中推导颜色、渐变、阴影、描边 token。 - `get_design_tokens`：从全文件或指定节点子树中推导颜色、渐变、阴影、描边 token。
- `inspect_fig_file`：读取本地 `.fig`，返回节点数量、类型统计和节点概览。 - `inspect_fig_file`：读取本地 `.fig`，返回节点数量、类型统计和节点概览。
- `get_fig_node`：按节点名、`2625:12945`、`2625-12945`、`node-id=2625-12945` 或完整 Figma 链接查找节点，并返回简化上下文。 - `get_fig_node`：按节点名、`1234:5678`、`1234-5678`、`node-id=1234-5678` 或完整 Figma 链接查找节点，并返回简化上下文。
- `export_fig_node`：把指定节点导出为 SVG 或 PNG，PNG 支持倍率。 - `export_fig_node`：把指定节点导出为 SVG 或 PNG，PNG 支持倍率。
## 示例参数 ## 示例参数
@ -21,8 +21,8 @@
```json ```json
{ {
"filePath": "D:\\MyFiles\\Download\\兴泰安全生产预计平台-朱梓鑫.fig", "filePath": "C:\\Users\\you\\Designs\\sample.fig",
"nodeQuery": "node-id=2625-12945", "nodeQuery": "node-id=1234-5678",
"depth": 2, "depth": 2,
"includeTokens": true, "includeTokens": true,
"includeCodeHints": true "includeCodeHints": true
@ -33,8 +33,8 @@
```json ```json
{ {
"filePath": "D:\\MyFiles\\Download\\兴泰安全生产预计平台-朱梓鑫.fig", "filePath": "C:\\Users\\you\\Designs\\sample.fig",
"nodeQuery": "2625-12945", "nodeQuery": "1234-5678",
"depth": 2 "depth": 2
} }
``` ```
@ -43,8 +43,8 @@
```json ```json
{ {
"filePath": "D:\\MyFiles\\Download\\兴泰安全生产预计平台-朱梓鑫.fig", "filePath": "C:\\Users\\you\\Designs\\sample.fig",
"query": "Group 1321315187", "query": "Primary Card",
"limit": 20 "limit": 20
} }
``` ```
@ -53,9 +53,9 @@
```json ```json
{ {
"filePath": "D:\\MyFiles\\Download\\兴泰安全生产预计平台-朱梓鑫.fig", "filePath": "C:\\Users\\you\\Designs\\sample.fig",
"nodeQueries": ["2625-12945", "Group 1321315187"], "nodeQueries": ["1234-5678", "Primary Card"],
"outputDir": "D:\\MyFiles\\Download\\fig-export-debug\\assets", "outputDir": "C:\\Users\\you\\Exports\\figma-local-context\\assets",
"format": "png", "format": "png",
"scale": 2 "scale": 2
} }
@ -65,8 +65,8 @@
```json ```json
{ {
"filePath": "D:\\MyFiles\\Download\\兴泰安全生产预计平台-朱梓鑫.fig", "filePath": "C:\\Users\\you\\Designs\\sample.fig",
"nodeQuery": "2625-12945" "nodeQuery": "1234-5678"
} }
``` ```
@ -74,7 +74,7 @@
```json ```json
{ {
"filePath": "D:\\MyFiles\\Download\\兴泰安全生产预计平台-朱梓鑫.fig", "filePath": "C:\\Users\\you\\Designs\\sample.fig",
"maxNodes": 20 "maxNodes": 20
} }
``` ```
@ -83,8 +83,8 @@
```json ```json
{ {
"filePath": "D:\\MyFiles\\Download\\兴泰安全生产预计平台-朱梓鑫.fig", "filePath": "C:\\Users\\you\\Designs\\sample.fig",
"nodeQuery": "node-id=2625-12945", "nodeQuery": "node-id=1234-5678",
"depth": 1 "depth": 1
} }
``` ```
@ -93,9 +93,9 @@
```json ```json
{ {
"filePath": "D:\\MyFiles\\Download\\兴泰安全生产预计平台-朱梓鑫.fig", "filePath": "C:\\Users\\you\\Designs\\sample.fig",
"nodeQuery": "2625-12945", "nodeQuery": "1234-5678",
"outputPath": "D:\\MyFiles\\Download\\fig-export-debug\\mcp-export-node.png", "outputPath": "C:\\Users\\you\\Exports\\figma-local-context\\sample-node.png",
"format": "png", "format": "png",
"scale": 2 "scale": 2
} }
@ -122,7 +122,7 @@ MCP 客户端配置示例：
"mcpServers": { "mcpServers": {
"Figma Local Context": { "Figma Local Context": {
"command": "cmd", "command": "cmd",
"args": ["/c", "pnpm", "--dir", "D:\\MyFiles\\Codes\\Node\\figma-local-context-mcp", "dev"] "args": ["/c", "pnpm", "--dir", "C:\\path\\to\\figma-local-context-mcp", "dev"]
} }
} }
} }
@ -135,7 +135,7 @@ MCP 客户端配置示例：
"mcpServers": { "mcpServers": {
"Figma Local Context": { "Figma Local Context": {
"command": "cmd", "command": "cmd",
"args": ["/c", "node", "D:\\MyFiles\\Codes\\Node\\figma-local-context-mcp\\dist\\bin.js", "--stdio"] "args": ["/c", "node", "C:\\path\\to\\figma-local-context-mcp\\dist\\bin.js", "--stdio"]
} }
} }
} }