designport

designport

designport 是一个兼容 Figma REST API 的客户端，以 MCP 服务和小型命令行工具的形式打包。它是针对同一公开上游 API（https://api.figma.com/v1）的独立客户端——并非 Figma 托管的 OAuth 远程 MCP 服务的副本，也未复现该服务的任何 OAuth 工具功能（设计上下文、截图、元数据、变量定义、code-connect、FigJam 或设计系统规则）。

此子集涵盖设计文件的读取：获取文件或特定节点、将节点渲染为图像、列出图像填充、样式和组件、浏览团队项目和项目文件，以及读取或发布文件评论。

身份验证使用 Figma 个人访问令牌，并通过 X-Figma-Token 标头发送。启动服务前，请设置 FIGMA_PERSONAL_ACCESS_TOKEN；未设置该变量时发起的调用会失败，并显示包含该变量名称的错误。可通过 FIGMA_API_BASE 覆盖 API 基础地址。

安装

npx @reneturcios/designport get_file <file_key>
docker run -i ghcr.io/cloudcorprecords/designport

命令行工具

designport get_file <file_key> --depth 2
designport get_file_nodes <file_key> 1:2,3:4
designport get_images <file_key> 1:2 --format png --scale 2
designport get_file_styles <file_key>
designport get_team_projects <team_id>
designport list_project_files <project_id>
designport post_comment <file_key> "Looks good"
designport --version

退出代码：0 表示成功，1 表示 API 错误，2 表示用法错误。

MCP 服务

npx -y @reneturcios/designport mcp

{
  "mcpServers": {
    "designport": {
      "command": "npx",
      "args": ["-y", "@reneturcios/designport", "mcp"],
      "env": { "FIGMA_PERSONAL_ACCESS_TOKEN": "your-token" }
    }
  }
}

工具

工具	输入	Figma 端点
get_file	file_key、version？、depth？	GET /files/{key}
get_file_nodes	file_key、node_ids、depth？、version？	GET /files/{key}/nodes
get_images	file_key、node_ids、format？、scale？	GET /images/{key}
get_image_fills	file_key	GET /files/{key}/images
get_file_styles	file_key	GET /files/{key}/styles
get_file_components	file_key	GET /files/{key}/components
get_team_projects	team_id	GET /teams/{id}/projects
list_project_files	project_id	GET /projects/{id}/files
get_comments	file_key	GET /files/{key}/comments
post_comment	file_key、message、client_meta？	POST /files/{key}/comments

node_ids 是以逗号分隔的节点 ID 字符串，会作为 API 的 ids 参数发送。post_comment 的可选参数 client_meta 是一个包含 JSON 编码对象的字符串，例如 '{"x":10,"y":20}'；该字符串会被解析后作为 API 的 client_meta 对象发送。将其保留为字符串可简化工具架构。

此子集不包括：变量 API、开发资源、库资源和搜索、Webhook、活动日志及付费功能。

开发

npm install
npm run build
npm test

测试完全使用模拟的 fetch 固定数据；不会使用网络，也不会使用真实令牌。

许可证

MIT — 参见 LICENSE。