provider/model slug. When the prompt leaves the model unnamed, the agent asks which slug to run and waits.
For a visual Excalidraw workspace with image prepare/confirm, HTML drafts, and presentations, see Agent Canvas instead.
The repository follows Agent Plugins 1.0.0, with portable skills and adapters for Claude Code, Codex, Cursor, OpenClaw, OpenCode, Pi, and Hermes. Root mcp.json declares Modellix Docs Search at https://docs.modellix.ai/mcp and Modellix Media Generation at https://tool.modellix.ai/mcp/media. The manifests contain the URLs only.
Plugin or Skill
The repository ships in two shapes. Pick the one your host supports.A skill-only install of
modellix-design includes execution. It does not include the prompt-planning or local-edit skills. See the Skill guide for per-skill installs.What the Plugin Provides
- Media Generation MCP when its tools are available and the input is a prompt or public URL:
modellix_get_schema, then onemodellix_submit_task, thenmodellix_wait_task - The CLI when Media Generation is unavailable, the input is a local file, or the task is a batch or download:
preflightwhen that path is selected, thenmodellix-cli doctor,model run --wait, andtask download - REST only when Media Generation and the CLI are both unavailable
- A question for the
provider/modelslug when you do not name one - Model discovery through
modellix_list_modelsandmodellix_get_schema, ormodellix-cli model list,model describe, andmodel get-schema, plus the live model index at llms.txt - Retry and error guidance aligned with CLI exit codes, including paid-submission safety rules
- Credential handling for
MODELLIX_API_KEYand saved CLI auth profiles
/modellix:prompt, /modellix:social-card, /modellix:infographic, /modellix:image, /modellix:video, /modellix:audio, /modellix:doctor, /modellix:models, /modellix:tasks, and /modellix:download.
On Cursor, a repeated modellix_submit_task for a model slug already submitted in the session asks for confirmation first.
Skills in the Plugin
modellix-design runs generation. modellix-image-prompt-engineering writes an image prompt and leaves the model choice to you. The four skills below plan prompts or edit files that are already on disk. Prompt-planning skills pass generation to modellix-design when you want a new asset. None of the four submits a paid task.
modellix-social-card, modellix-infographic, modellix-ffmpeg, and modellix-moviepy ship with the plugin and with a checkout of the repository. They are separate from the Smithery and ClawHub listing for modellix-design.
Requirements
- A Modellix API key from the Modellix Console
- Recommended:
modellix-clion Node.js 18.17 or later - Python 3.10 or later when you want automatic CLI preflight. Media Generation, direct CLI, and REST use remain available without Python
skills/modellix-design/scripts/preflight.py checks public npm latest and, when that version is newer, installs that exact CLI version before execution. Set MODELLIX_CLI_AUTO_UPDATE=0 when the environment must keep its installed CLI. A registry or install failure keeps a working CLI. When no CLI is usable and MODELLIX_API_KEY is set, preflight recommends REST.
The plugin still runs when the CLI is absent: Media Generation MCP when that server is connected, and the REST API when both Media Generation and the CLI are unavailable. The CLI adds local-file uploads, batch, built-in waiting, and safer downloads.
Install as a Plugin
The published npm package
@modellix/modellix-plugin is 4.2.2. That package still uses the CLI-first workflow and built-in default models. GitHub marketplace installs, git checkouts, and npx skills add from https://github.com/Modellix/modellix-plugin install 4.7.0.--force to update an existing installation while retaining its previous directory as a backup. To materialize the complete bundle for another compatible host, use install --host portable --target ./modellix-plugin and open that directory through the host’s local plugin flow. Plain npm install downloads the package without registering it in every host. The command above is pinned to 4.2.2, so --force and install --host portable install that same package.
- Claude Code
- Codex
- Cursor
- OpenClaw
- Pi
Install from the GitHub repository (4.7.0):Update:You can also use the
/plugin UI, then run /reload-plugins if the plugin does not appear.For local development against a clone:Install as a Skill
When your host has no plugin marketplace, or you want one skill, install it from the GitHub repository (4.7.0):modellix-design executes image, video, and audio workflows. modellix-image-prompt-engineering prepares image prompts. The Skill guide covers skill installs for skills.sh, ClawHub, OpenCode, Cursor, Pi, Hermes, and Smithery, and explains which skills are plugin-only.
Configure Your API Key
Every install shape reads the same credential for CLI and REST.--api-key, then MODELLIX_API_KEY, then the selected saved profile.
- REST calls require
MODELLIX_API_KEY. - The CLI can use the environment variable or a saved profile created by
modellix-cli auth loginormodellix-cli init. - Media Generation expects the host to attach
Authorization: Bearertohttps://tool.modellix.ai/mcp/media. Use the host’s secret store. The plugin manifests declare the URL only. - In Cursor, the
MODELLIX_API_KEYplugin variable covers the CLI and REST paths. It does not become the Media GenerationAuthorizationheader. - In Hermes, prefer
~/.hermes/.envor the secure prompt shown when the skill loads.
Verify the Install
Confirm the environment first, then generate one asset end to end. Name the model in the prompt.1
Check the CLI and Credentials
doctor reports the Node.js version, the API-key source, API connectivity, and your team balance without printing the key. The Media Generation path uses the host’s Authorization header and does not run this check first.2
Ask Your Agent to Generate Something
google/nano-banana-2-lite in that prompt is a slug you chose. When you omit the slug, the agent asks which model to run. With Media Generation connected and a prompt or public URL as input, it submits through that MCP server and waits for the task. It uses the CLI when that path is unavailable, and REST when the CLI is unavailable too.3
Confirm the Output
The agent saves results before they expire (about 7 days). To reproduce the CLI path manually:
Supported Task Types
Exact request bodies come from
modellix_get_schema or modellix-cli model get-schema. The Skill guide lists the required fields.
Name a Model
The plugin uses theprovider/model slug you name. When you leave it unnamed, the agent asks and waits. Listing models shows options. It does not authorize a submit, and the agent does not pick a slug from that list for you.
modellix_list_models and modellix_get_schema. modellix_get_schema is public and does not need an API key. JSON is the default for model get-schema. See the CLI schema command and Media Generation MCP.
The agent reads the schema before a non-trivial submit. It skips that call when you already supplied a complete body. If neither Media Generation nor the CLI can provide the schema, it uses Docs Search when connected, then docs_url from model describe, or the model page in llms.txt.
How the Plugin Runs Tasks
- It uses Media Generation MCP when
modellix_submit_taskis available and the input is a prompt or public URL. A local file, a protocol error, or401leaves this path. Those outcomes are reasons to switch paths, and the agent does not retry the same MCP call. - It uses the CLI after
scripts/preflight.py --jsonwhen that path is selected and Python is available. Preflight may install a newer exact CLI from public npmlatest. Local files, batch,task download, and the private-network CDN fallback use the CLI. - It uses the REST API only when the Media Generation tools are absent and the CLI is unavailable.
- It reads the request schema with
modellix_get_schemaormodel get-schemabefore a non-trivial submit, and skips that call when you already supplied a complete body. - It uses
modellix_wait_task,model run --wait, ortask waitinstead of a hand-written polling loop. A Media Generation deadline withdata.wait.timed_out=trueis a snapshot. The agent waits again with the same task ID. - It does not submit the same paid request again after an unknown outcome.
submission_unknown, or a connection drop before a trustworthy response, does not startmodel runor a REST POST for that request. When a task ID came back, it continues withmodellix_get_taskormodellix_wait_task. When no ID came back, it checksmodellix-cli task historyfirst. - Its REST fallback rejects redirects on authenticated requests, bounds response reads by the remaining deadline, and preserves known task IDs on timeout.
- It may use the helper scripts bundled in
skills/modellix-design/scripts/, and falls back to plain CLI commands if a helper fails. - On Cursor, it asks before a repeated
modellix_submit_taskfor a model slug already submitted in the session. - It treats
modellix-cli --helpand the npm package as the source of truth for CLI behavior.
Troubleshooting
Next Steps
Skill
Install one Agent Skill on its own.
Media Generation MCP
See the tools the plugin calls when Media Generation is connected.
CLI
Learn the
modellix-cli commands the plugin runs.REST API
Call Modellix directly without the CLI.
Pricing
Review model pricing before running paid tasks.