Skip to main content
Glama

Server Configuration

Describes the environment variables required to run the server.

NameRequiredDescriptionDefault

No arguments

Instructions

Guidance the server publishes about itself, which clients place ahead of the tool catalog so the model reads it before choosing anything.

This server publishes no instructions, or was last inspected before Glama recorded them.

Capabilities

Features and capabilities supported by this server

Protocol revision2025-11-25

CapabilityDetails
tools
{}
prompts
{}
resources
{}

Tools

Functions exposed to the LLM to take actions

NameDescription
health_checkA

Check connectivity to the remote mlx-serve instance.

Pings GET /health on the configured server. Use this first to verify that the ip:port is reachable before running any generation.

list_modelsA

List models available on the remote mlx-serve server with their capabilities.

Returns each model's id plus capability flags: chat/vision, image engine, speech (TTS) engine, music backend, video engine, and 3D mesh engine. Pick ids from this list for the model argument of generation tools; a media tool without model uses whatever matching model the server has loaded or configured as default.

load_modelA

Explicitly cold-load a model on the remote mlx-serve server into GPU memory.

Args: model: Model id as returned by list_models (or an absolute path to a model directory on the SERVER machine). make_default: Also promote it to the server-wide default model. Leave false for side-loaded media models so chat traffic keeps its current default.

unload_modelA

Free a model's GPU memory on the remote mlx-serve server.

The model stays registered (it can be reloaded later); only its resident weights are evicted. Useful after heavy media generation to reclaim unified memory.

generate_imageA

Generate an image from a text prompt on the remote server.

The image is saved as a local PNG file; the returned text includes the absolute path of the saved file.

Args: prompt: Text description of the image to generate. model: Model id (from list_models). Defaults to MLX_SERVE_IMAGE_MODEL (or the built-in default if unset). size: Output dimensions, e.g. "512x512" or "1024x1024". seed: Optional random seed for reproducibility. steps: Sampling steps (backend-specific). cfg_scale: Classifier-free guidance scale (SDXL/Flux style). guidance_scale: Guidance scale (MAGE-Flow style).

edit_imageA

Edit an existing image with a text prompt.

Args: image_path: Absolute or ~-relative path to the source image (PNG/JPEG). prompt: Description of the desired edit. model: Model id. Defaults to MLX_SERVE_IMAGE_EDIT_MODEL. size: Output dimensions. strength: Denoising strength 0..1 (how much to change the image). seed: Optional random seed.

text_to_speechA

Synthesize speech from text; returns a local WAV file path.

Args: text: The text to speak. model: TTS model id. Defaults to MLX_SERVE_TTS_MODEL. voice: Voice name or id (backend-specific). speed: Playback speed multiplier (0.25..4.0, default 1.0).

generate_musicA

Generate a music track from a style prompt; returns a local WAV path.

Args: prompt_style: Style description, e.g. "lo-fi hip hop, mellow piano". model: Music model id. Defaults to MLX_SERVE_MUSIC_MODEL. lyrics: Optional lyrics for vocal tracks. instrumental: True for no vocals (default true for text2music). duration_seconds: Target length 10..600 (default 60). bpm: Tempo, e.g. 120. keyscale: Musical key, e.g. "C major" / "E minor". timesignature: Time signature, e.g. "4/4". vocal_language: Vocal language code for sung lyrics, e.g. "en", "zh". task: "text2music" (default) | "cover" | "complete". src_audio_path: Local WAV (10-600 s) source for cover/complete tasks; its length becomes the output length. cover_strength: 0..1 how strongly to follow the cover source (default 1). seed: Optional seed for reproducibility. steps: Optional sampling steps (music3 backend only).

generate_videoA

Generate a short video from a text prompt; returns a local MP4 path.

mlx-serve answers with raw frames (+ optional soundtrack); this tool encodes them into an H.264 MP4 (AAC audio when present) locally via ffmpeg, so the returned file is playable anywhere. Generation is slow — minutes per clip depending on frame count and resolution.

Args: prompt: Scene description for the video. model: Video model id. Defaults to MLX_SERVE_VIDEO_MODEL. num_frames: Frame count. LTX backends use an 8N+1 ladder (default 9; e.g. 9/25/33/49/57/81...); MiniMax-H3 uses 17k+5 (default 56). width: Pixel width (defaults: LTX 384, H3 256). Two-stage pipelines need both dimensions divisible by 64. height: Pixel height (defaults: LTX/H3 256). steps: Sampling steps (backend-specific defaults). turbo: Use the distilled 4-step turbo path where the model pack provides it. seed: Optional seed. cfg_scale: Guidance scale. first_frame_image_path: Optional local image to condition the first frame. last_frame_image_path: Optional local image to condition the final frame. audio_path: Optional local WAV to mix as soundtrack (must match frame duration).

generate_3dA

Generate a textured 3D mesh (GLB) from a subject image on the remote server.

The image should be a clean cutout of the subject with real alpha transparency (an opaque photo also works — the server composites it on white). Returns a GLB file path you can open in Blender / three.js / Quick Look.

Args: image_path: Absolute or ~-relative path to a local PNG/JPEG of the subject. model: 3D mesh model id. Defaults to MLX_SERVE_MESH_MODEL. steps: Shape sampling steps (default 30). octree_resolution: Mesh grid resolution in [64, 512] (default 256). guidance_scale: Shape guidance in [0, 20] (default 5). texture: Request the texture-paint stage for a textured GLB. Requires the paint weights to be installed server-side, else a named error. texture_steps: Texture painting steps in [1, 100] when texture=true. seed: Optional seed.

Prompts

Interactive templates invoked by user choice

NameDescription
create_posterDesign a text-centric poster or typographic artwork (title, tagline, labels). Uses Mage-Flow-Turbo, which is the most reliable model for rendering text inside images.
portrait_photoGenerate a realistic portrait or photo-real scene. Uses FLUX.2-klein-4B, the best model in the mlx-serve group for faces and photo-real detail.
lofi_trackProduce a 60-second lo-fi hip hop instrumental with mellow piano, chill beats and vinyl crackle — a ready-made background-music track.
speak_textSpeak a passage of text aloud as a WAV file using the Qwen3-TTS voice model.
image_to_3dTurn a clean cutout photo of an object (real alpha transparency works best) into a textured 3D model file (GLB) for Blender, three.js or Quick Look.
short_videoGenerate a short, low-resolution video clip (9 frames, 256x256) — the fastest video path on mlx-serve, good for previews and tests.

Resources

Contextual data attached and managed by the client

NameDescription
modelsLive model inventory from the remote mlx-serve instance — model ids, capability flags (chat, vision, image, speech, music, video, 3D) and load status.
server_statusHealth and status of the remote mlx-serve instance — reachable, version, loaded models, GPU info.
model_guidanceRecommended model choices for each media tool based on real-world testing (which model for text rendering, faces, music, video, 3D).

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/Congenital/mlx-serve-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server