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 分