Vectreal

io.github.Vectreal由 GitHub 账号 Vectreal 发布v3.1.0更新于 Oct 29, 2026

Upload, publish and embed 3D models on any website from your agent.

已验证STDIO仅桌面云端与基础设施开发者工具媒体与设计

概览

AI 生成的概览

Vectreal 的命令行 MCP 服务器，让助手上传本地 GLB 模型、配置并发布 3D 场景，并获取网站嵌入代码。

可以做什么
  • 无需登录即可搜索和阅读 Vectreal 文档
  • 查看当前登录用户、组织、项目与场景，并可创建项目
  • 把本地 GLB 上传为草稿场景，并描述其尺寸、网格、材质和动画片段
  • 读取并修改场景设置，如光照、环境、控制、边界、阴影和展示方式
  • 压缩并发布本地 GLB、下线场景，并获取嵌入代码和预览链接
适用场景
适合在 Vectreal 组织中处理 3D 资产时使用，让助手直接在项目目录里上传、配置、发布或嵌入场景，而不必打开网页控制台。
运行要求
通过 npm 包 @vctrl/cli 以 stdio 在本地运行（npx 或全局安装）。需要 Vectreal 账号，并先用 vectreal login 在浏览器中登录，会话保存在操作系统钥匙串中。需要能访问 Vectreal 服务地址（默认 vectreal.com，或 VECTREAL_ORIGIN）。项目需用 vectreal init 关联，或通过 CLAUDE_PROJECT_DIR 定位。
安装前请注意
这些工具会真实改动组织数据：创建项目、上传文件、修改场景设置、发布或下线场景，还可创建嵌入密钥并允许域名。会话保存在系统钥匙串中；没有钥匙串时会写入配置目录下的凭据文件。上传的 GLB 文件和场景数据会发送到 Vectreal 服务。

安装

在 SourceWeft 中

  1. 打开 控制台中的 Vectreal，将其添加到工作区。
  2. 为需要使用其工具的对话启用该服务。

Desktop only，通过 STDIO。 STDIO 服务会启动本地进程，因此需要 SourceWeft 桌面宿主。

其他 MCP 客户端

参照 仓库 中的启动说明。

README

@vctrl/cli

The Vectreal command line: sign in once, then let a terminal or an agent act for you in the organization you chose.

Run it with npx, or install it globally to get the vectreal command:

bash
npx -y @vctrl/cli login
bash
npm install -g @vctrl/cli

Setup for Claude Code, Cursor and VS Code is in the agents docs.

Commands

CommandWhat it does
vectreal login [--origin <url>] [--no-browser]Signs in through the browser and keeps the session in the OS keychain. Remembers the origin for later commands.
vectreal whoami [--json]Shows the user, organization, role and scopes the session acts as.
vectreal init [--project <id> | --create <name>]Links the current directory to a project by writing .vectreal/project.json.
vectreal logoutEnds the session on the server and forgets it here.
vectreal mcpServes the Vectreal tools to an agent over stdio (MCP) until the agent closes the stream.
vectreal mcp install [--origin <url>]Registers that server in the current directory's .mcp.json, launched the way this CLI was.

The origin is --origin, then VECTREAL_ORIGIN, then the last one signed in to, then https://vectreal.com. Plain http is allowed on localhost only.

The MCP server

vectreal mcp gives an agent these tools:

ToolDoes
search_docs, read_docSearch and read the Vectreal docs. No sign-in needed.
whoami, list_projects, create_project, list_scenesWho the session is, and the organization's projects and scenes.
create_scene_from_fileUploads a local GLB as a draft scene, as it is.
describe_modelA local GLB's size, meshes, materials and animation clips, and where the viewer places it, without rendering it.
get_scene_settings, update_scene_settingsRead every settings section; change lighting, environment, controls, bounds, shadows and presentation. Lighting supersedes environment and shadows once a scene has it.
publish_scene, unpublish_sceneCompress a local GLB as the publisher does (Draco, KTX2) and publish it; take a scene offline.
get_embed_snippetThe snippet and preview URL for a published scene, creating an embed key and allowing domains when asked.

Tools that take projectId default to the project vectreal init linked. The server finds that project in CLAUDE_PROJECT_DIR when the agent sets it, else in the directory it was started from. It signs in with the stored session, so run vectreal login first; a tool called without one says so.

To register it with Claude Code, run this in the project directory:

bash
claude mcp add vectreal -- npx -y @vctrl/cli mcp

Or let the CLI write the entry into the current directory's .mcp.json:

bash
npx -y @vctrl/cli mcp install

Run from npx, the entry it writes is npx -y @vctrl/cli mcp, so .mcp.json can be committed. Run from a checkout of this repository, it names paths on that machine instead.

The server is also listed in the MCP Registry as io.github.Vectreal/vectreal.

Output and exit codes

Results go to stdout, as JSON with --json. Everything else goes to stderr.

CodeMeaning
0Done
1Failed
2Wrong usage
3Not signed in, or the server no longer accepts the session: run vectreal login

Where the session is kept

In the OS keychain (macOS Keychain, Windows Credential Manager, Secret Service on Linux), one entry per origin. Where the keychain cannot be used, as on a headless Linux box with no Secret Service, the session goes to $XDG_CONFIG_HOME/vectreal/credentials.json (default ~/.config/vectreal) instead, and each command that does so says it on stderr. On macOS and Linux that file is readable only by you; on Windows it relies on your profile folder's permissions.

Signing in against a local stack

Register the CLI's OAuth client on the local Supabase stack once, then point the CLI at the dev server:

bash
pnpm nx run vectreal-platform:supabase-register-cli-client
bash
pnpm -s vectreal login --origin http://localhost:4200

From a checkout, use pnpm's -s: without it, pnpm prints its own banner to stdout before the CLI does, which breaks anything reading --json output.

来源：packages/cli/README.md，提交 ad294e2

工具

0
SourceWeft 尚未在沙箱中启动过该软件包，因此其工具未知。

版本历史

1
  1. v3.1.0最新Oct 29, 2026

评分

已满足适用检查项的 50%

该评分衡量此收录条目的完整程度，依据注册中心条目、端点与公开来源计算得出。它不是对服务器本身的评价，也不表示服务器安全或当前可用：可连通性是带日期的检查结果，评分也不包含安装量或用户评价。

  • 近 30 天内可连通25 分

    请保持端点能够响应 MCP 握手；SourceWeft 每 30 天探测一次。

  • 已声明认证方式10 分

    请在注册中心条目中声明凭据请求头，或保持端点能够响应探测，以便判定其认证方式。

  • 已列出工具15 分

    请让服务器在无凭据时响应 tools/list，或发布可在沙箱中无凭据启动的软件包。

  • 描述必需15 分
  • 图标10 分
  • 文档15 分
  • 许可证10 分