meshy-dev__meshy-3d-agent/README.md

Meshy 3D Agent

Meshy skills for creating digital assets and preparing 3D prints. The generation and printing skills drive Meshy CLI 0.3.0 (meshy) on Node.js 24+. They are instructions and references only — no bundled runtime scripts. This is the 0.5.0 development candidate.

Start by asking for what you want

Install the skills (below), then say the thing, in your own words:

Turn this photo into a textured GLB and save it to ./assets/chest.glb. Set it up if it isn't yet.

The agent resolves the CLI, checks whether a session already exists and, if not, starts one browser login and shows you a link and a code. You approve in the browser; nothing is pasted into the chat, no API key is copied, and the agent then continues the request you actually made. The file lands at the path you named — ./meshy_output is only the fallback when you name none — with a rendered preview alongside it and the task IDs for whatever you ask next ("make a 1500-face LOD", "now as FBX", "scale it to 150 mm").

Two more things worth knowing:

• No global CLI needed. With Node 24+ the agent runs the pinned package temporarily (npm exec --yes --package=meshy-cli@0.3.0 -- meshy …). A global npm install -g meshy-cli@0.3.0 only makes startup faster.
• Local print work needs no account. Rescaling an OBJ or opening a 3MF in a slicer runs entirely on your machine — no login, no balance check, no credits.

Doing it by hand instead

npm install -g meshy-cli@0.3.0
meshy --version
meshy auth login
meshy auth status --format json --no-update-check

Run meshy auth login from a desktop terminal and approve in your browser; in SSH, CI or container sessions use meshy auth login --device and open the verification URL it prints. Keep the login process alive until you have approved. The CLI stores and refreshes the session; both skills reuse it under the same OS user and CLI configuration, in any directory.

An existing MESHY_API_KEY overrides the stored browser session — keep it if that is intentional; auth status reports the effective source. Explicit key files need --api-key-file; the CLI never searches .env. Never paste a key into a chat. The self-contained setup reference has the version, path and error handling in full.

Skills

Skill	Workflow
meshy-3d-generation	Text/image/2D/motion, textures, remesh, conversion, sizing, UV, rigging and animation
meshy-3d-printing	White models, multi-color 3MF, analysis/repair, Creative Lab products and slicers

Printing installs independently and controls its generation parameters from the start. Requested formats and already-approved budgets are preserved. Cost estimates come from meshy make --dry-run or the published price list, never from your balance; the real charge is the task's own consumed_credits. No live spending happens during install.

Install these directories with your host's skills installer, or copy each whole directory:

• Claude Code: .claude/skills/ (the repository also retains its Claude plugin manifest).
• Cursor: .cursor/skills/ (Cursor plugin manifest retained).
• Codex: .agents/skills/.

Replace a prior managed skill directory rather than merging files, so old scripts/ files are removed. Back up personal edits before replacement. Do not remove model projects or CLI state. Host discovery and browser interaction require a real host smoke test; local contract tests alone do not certify a host or operating system.

OpenClaw compatibility boundary

skills/meshy-openclaw remains the separate 0.4.1 legacy Python skill, unchanged by this migration of the two named skills. Its own prerequisites and API-key setup still apply; it does not gain CLI browser-session sharing. Do not install all skills expecting all three to use the CLI. Legacy reference/source.md and scripts/src/meshy_task.py belong to that older skill, not the two CLI skills.

Data and local effects

The CLI sends prompts, media and task requests to the resolved Meshy API origins (normally api.meshy.ai); OAuth opens Meshy's browser page. Asset downloads and input URL preflights contact their media hosts without the API credential. npm is contacted when the CLI is installed or run as a temporary package; workflow commands disable the update notifier. An unexpected custom API or login origin must be resolved before credentials are sent.

CLI profiles normally live in ~/.config/meshy/credentials.json with mode 0600. MESHY_CONFIG_DIR moves the config root, including operation and device-flow state; MESHY_CREDENTIALS_PATH overrides only the credential file. The skills never read or copy tokens, and never print a token, device code or signed URL. auth use changes the shared active profile, so concurrent tasks should not switch accounts independently. Profile sharing is local, not automatic across machines or containers.

Models, task snapshots and project metadata are written inside one workspace per job: the directory you named, or ./meshy_output when you named none. Every writing command carries that boundary explicitly, so a path outside it — including through a symlink — is refused rather than written. Downloads are selected, not fetched in every format; existing files are not overwritten without --overwrite. OBJ preparation writes a new file. Slicer integration launches a detected installed application; a launch request is not proof the model was imported.

Development and validation

Only maintainers need Python 3.11+ and PyYAML. None of these tools ships in the CLI skill folders.

python3 scripts/build.py
python3 scripts/build.py --check
python3 scripts/validate_skills.py
MESHY_CLI_BIN=/absolute/path/to/meshy node --test tests/*.test.mjs

build.py copies the shared setup, delivery and troubleshooting references from generation to printing so each skill directory installs on its own; --check fails when a copy is stale. validate_skills.py checks frontmatter, link closure, the absence of bundled runtime files, the JSON envelope and resolved workspace placeholder on every documented CLI command, and the plugin manifests. Neither touches OpenClaw.

Tests use a loopback API, synthetic credentials and temporary config/workspace directories. tests/runner-contract.test.mjs additionally runs the documented npm exec entry point, so it populates an isolated npm cache from the registry on its first run and needs no MESHY_CLI_BIN. CI installs the pinned CLI into a temporary prefix; tests never contact production or spend credits. Without MESHY_CLI_BIN, the CLI contract tests skip explicitly — a skip is not a pass, so set it.

Upgrade and rollback

Old task IDs remain usable. Initialize or reopen a CLI project and resume the original resource's wait; never recreate a task just to migrate. The CLI backs up legacy metadata when first writing its newer schema. Keep that backup. Returning to an old Python skill requires its old runtime and API-key setup; it cannot use the CLI OAuth store. Backward reading of newer project metadata is not guaranteed. Keep the CLI for inspecting in-flight tasks rather than submitting again.

License

MIT