Configuration Reference

August 17, 2026 ยท View on GitHub

Server Configuration

Basic Options

OptionDescriptionDefault
--hostServer host address127.0.0.1
--portServer port8000
--max-tokensDefault max tokens32768
--max-request-tokensMaximum max_tokens accepted from API clients32768
--default-temperatureDefault temperature when not specified in requestNone
--default-top-pDefault top_p when not specified in requestNone
--default-chat-template-kwargsDefault chat template kwargs used when request chat_template_kwargs is omitted (JSON object)None

Security Options

OptionDescriptionDefault
--api-keyAPI key for authenticationNone
--rate-limitRequests per minute per client (0 = disabled)0
--timeoutRequest timeout in seconds300
--enable-metricsExpose Prometheus metrics on /metricsfalse
--max-audio-upload-mbMaximum uploaded audio size for /v1/audio/transcriptions25
--max-tts-input-charsMaximum text length accepted by /v1/audio/speech4096

Batching Options

OptionDescriptionDefault
--continuous-batchingEnable batchingfalse
--stream-intervalTokens per stream chunk1
--max-num-seqsMax concurrent sequences256

Cache Options

OptionDescriptionDefault
--cache-memory-mbCache memory limit in MBAuto
--cache-memory-percentFraction of RAM for cache0.20
--no-memory-aware-cacheUse legacy entry-count cachefalse
--use-paged-cacheEnable paged KV cachefalse
--paged-cache-block-sizeTokens per block64
--max-cache-blocksMaximum blocks1000
--prefix-trie-cacheEnable conversation-prefix reuse in pure-LLM SimpleEngine modefalse
--prefix-trie-cache-sizeMaximum SimpleEngine prompt-trie entries32
--prefix-trie-cache-memory-mbOptional SimpleEngine prompt-trie memory cap in MBNone

Tool Calling Options

OptionDescriptionDefault
--enable-auto-tool-choiceEnable automatic tool callingfalse
--tool-call-parserTool call parser (see Tool Calling)None

Reasoning Options

OptionDescriptionDefault
--reasoning-parserParser for reasoning models (qwen3, deepseek_r1)None

Embedding Options

OptionDescriptionDefault
--embedding-modelPre-load an embedding model at startupNone

MCP Options

OptionDescriptionDefault
--mcp-configPath to MCP config fileNone

MCP Configuration

Create mcp.json:

{
  "mcpServers": {
    "server-name": {
      "command": "npx",
      "args": ["-y", "@modelcontextprotocol/server-name", "arg1"],
      "env": {
        "ENV_VAR": "value"
      }
    }
  }
}

MCP Server Options

FieldDescriptionRequired
commandExecutable commandYes
argsCommand argumentsYes
envEnvironment variablesNo

API Request Options

Chat Completions

ParameterDescriptionDefault
modelModel nameRequired
messagesChat messagesRequired
max_tokensMax tokens to generate256
temperatureSampling temperatureModel default
top_pNucleus samplingModel default
streamEnable streamingtrue
stopStop sequencesNone
toolsTool definitionsNone
response_formatOutput format (json_object, json_schema)None

Multimodal Options

ParameterDescriptionDefault
video_fpsFrames per second2.0
video_max_framesMax frames32

Environment Variables

VariableDescription
VLLM_MLX_TEST_MODELDefault model for tests
HF_TOKENHuggingFace authentication token
OPENAI_API_KEYSet to any value for SDK compatibility

Example Configurations

Development (Single User)

vllm-mlx serve mlx-community/Llama-3.2-3B-Instruct-4bit

Production (Multiple Users)

vllm-mlx serve mlx-community/Qwen3-0.6B-8bit \
  --continuous-batching \
  --use-paged-cache \
  --api-key your-secret-key \
  --rate-limit 60 \
  --port 8000

With Tool Calling

vllm-mlx serve mlx-community/Devstral-Small-2507-4bit \
  --enable-auto-tool-choice \
  --tool-call-parser mistral \
  --continuous-batching

With MCP Tools

vllm-mlx serve mlx-community/Qwen3-4B-4bit \
  --mcp-config mcp.json \
  --enable-auto-tool-choice \
  --tool-call-parser qwen \
  --continuous-batching

Reasoning Model

vllm-mlx serve mlx-community/Qwen3-8B-4bit \
  --reasoning-parser qwen3 \
  --continuous-batching

With Embeddings

vllm-mlx serve mlx-community/Qwen3-4B-4bit \
  --embedding-model mlx-community/multilingual-e5-small-mlx \
  --continuous-batching

High Throughput

vllm-mlx serve mlx-community/Qwen3-0.6B-8bit \
  --continuous-batching \
  --stream-interval 5 \
  --max-num-seqs 256