Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs2.openclaw.ai/llms.txt

Use this file to discover all available pages before exploring further.

vLLM 可以通过 OpenAI 兼容 HTTP API 提供开源(以及一些自定义)模型。OpenClaw 使用 openai-completions API 连接到 vLLM。 当你选择启用 VLLM_API_KEY 时,OpenClaw 也可以从 vLLM 自动发现可用模型(如果你的服务器不强制执行认证,则任意值都可以)。当你还配置了自定义 vLLM 基础 URL 时,在 agents.defaults.models 中使用 vllm/* 可保持发现动态化。 OpenClaw 将 vllm 视为支持流式使用量统计的本地 OpenAI 兼容提供商,因此状态/上下文 token 计数可以通过 stream_options.include_usage 响应更新。
属性
提供商 IDvllm
APIopenai-completions(OpenAI 兼容)
凭证VLLM_API_KEY 环境变量
默认基础 URLhttp://127.0.0.1:8000/v1

入门指南

1

启动带 OpenAI 兼容服务器的 vLLM

你的基础 URL 应公开 /v1 端点(例如 /v1/models/v1/chat/completions)。vLLM 通常运行在:
http://127.0.0.1:8000/v1
2

设置 API key 环境变量

如果你的服务器不强制执行认证,则任意值都可以:
export VLLM_API_KEY="vllm-local"
3

选择模型

替换为你的某个 vLLM 模型 ID:
{
  agents: {
    defaults: {
      model: { primary: "vllm/your-model-id" },
    },
  },
}
4

验证模型可用

openclaw models list --provider vllm

模型发现(隐式提供商)

当设置了 VLLM_API_KEY(或存在认证配置文件),并且你没有定义 models.providers.vllm 时,OpenClaw 会查询:
GET http://127.0.0.1:8000/v1/models
并将返回的 ID 转换为模型条目。
如果你显式设置了 models.providers.vllm,OpenClaw 默认使用你声明的模型。当你希望 OpenClaw 查询该已配置提供商的 /models 端点并包含所有公布的 vLLM 模型时,请将 "vllm/*": {} 添加到 agents.defaults.models

显式配置(手动模型)

在以下情况使用显式配置:
  • vLLM 运行在不同的主机或端口
  • 你想固定 contextWindowmaxTokens
  • 你的服务器需要真实的 API key(或你想控制请求头)
  • 你连接到受信任的 loopback、LAN 或 Tailscale vLLM 端点
{
  models: {
    providers: {
      vllm: {
        baseUrl: "http://127.0.0.1:8000/v1",
        apiKey: "${VLLM_API_KEY}",
        api: "openai-completions",
        request: { allowPrivateNetwork: true },
        timeoutSeconds: 300, // Optional: extend connect/header/body/request timeout for slow local models
        models: [
          {
            id: "your-model-id",
            name: "Local vLLM Model",
            reasoning: false,
            input: ["text"],
            cost: { input: 0, output: 0, cacheRead: 0, cacheWrite: 0 },
            contextWindow: 128000,
            maxTokens: 8192,
          },
        ],
      },
    },
  },
}
若要让此提供商保持动态,而无需手动列出每个模型,请向可见模型目录添加提供商通配符:
{
  agents: {
    defaults: {
      models: {
        "vllm/*": {},
      },
    },
  },
}

高级配置

vLLM 被视为代理式 OpenAI 兼容 /v1 后端,而不是原生 OpenAI 端点。这意味着:
行为是否应用?
原生 OpenAI 请求塑形
service_tier不发送
Responses store不发送
Prompt-cache 提示不发送
OpenAI 推理兼容载荷塑形不应用
隐藏 OpenClaw 归因请求头不注入到自定义基础 URL
对于通过 vLLM 提供的 Qwen 模型,当服务器期望 Qwen chat-template kwargs 时,请在模型条目上设置 params.qwenThinkingFormat: "chat-template"。OpenClaw 会将 /think off 映射为:
{
  "chat_template_kwargs": {
    "enable_thinking": false,
    "preserve_thinking": true
  }
}
off thinking 级别会发送 enable_thinking: true。如果你的端点改为期望 DashScope 风格的顶层标志,请使用 params.qwenThinkingFormat: "top-level" 在请求根部发送 enable_thinking。也接受 snake-case params.qwen_thinking_format
vLLM/Nemotron 3 可以使用 chat-template kwargs 控制推理是作为隐藏推理返回,还是作为可见答案文本返回。当 OpenClaw 会话在关闭 thinking 时使用 vllm/nemotron-3-*,内置 vLLM 插件会发送:
{
  "chat_template_kwargs": {
    "enable_thinking": false,
    "force_nonempty_content": true
  }
}
若要自定义这些值,请在模型 params 下设置 chat_template_kwargs。如果你也设置了 params.extra_body.chat_template_kwargs,该值具有最终优先级,因为 extra_body 是最后的请求体覆盖项。
{
  agents: {
    defaults: {
      models: {
        "vllm/nemotron-3-super": {
          params: {
            chat_template_kwargs: {
              enable_thinking: false,
              force_nonempty_content: true,
            },
          },
        },
      },
    },
  },
}
首先确保 vLLM 已使用适合该模型的正确 tool-call 解析器和 chat template 启动。例如,vLLM 文档说明 Qwen2.5 模型使用 hermes,Qwen3-Coder 模型使用 qwen3_xml症状:
  • skills 或工具从不运行
  • assistant 打印原始 JSON/XML,例如 {"name":"read","arguments":...}
  • 当 OpenClaw 发送 tool_choice: "auto" 时,vLLM 返回空的 tool_calls 数组
某些 Qwen/vLLM 组合仅在请求使用 tool_choice: "required" 时返回结构化 tool calls。对于这些模型条目,请使用 params.extra_body 强制设置 OpenAI 兼容请求字段:
{
  agents: {
    defaults: {
      models: {
        "vllm/Qwen-Qwen2.5-Coder-32B-Instruct": {
          params: {
            extra_body: {
              tool_choice: "required",
            },
          },
        },
      },
    },
  },
}
Qwen-Qwen2.5-Coder-32B-Instruct 替换为以下命令返回的确切 ID:
openclaw models list --provider vllm
你也可以从 CLI 应用相同覆盖:
openclaw config set agents.defaults.models '{"vllm/Qwen-Qwen2.5-Coder-32B-Instruct":{"params":{"extra_body":{"tool_choice":"required"}}}}' --strict-json --merge
这是一个需要选择启用的兼容性规避方案。它会让带工具的每个模型轮次都需要一次 tool call,因此只应在专用本地模型条目上使用,前提是该行为可以接受。不要将它用作所有 vLLM 模型的全局默认值,也不要使用会盲目将任意 assistant 文本转换为可执行 tool calls 的代理。
如果你的 vLLM 服务器运行在非默认主机或端口,请在显式提供商配置中设置 baseUrl
{
  models: {
    providers: {
      vllm: {
        baseUrl: "http://192.168.1.50:9000/v1",
        apiKey: "${VLLM_API_KEY}",
        api: "openai-completions",
        request: { allowPrivateNetwork: true },
        timeoutSeconds: 300,
        models: [
          {
            id: "my-custom-model",
            name: "Remote vLLM Model",
            reasoning: false,
            input: ["text"],
            contextWindow: 64000,
            maxTokens: 4096,
          },
        ],
      },
    },
  },
}

故障排除

对于大型本地模型、远程 LAN 主机或 tailnet 链接,请设置提供商级请求超时:
{
  models: {
    providers: {
      vllm: {
        baseUrl: "http://192.168.1.50:8000/v1",
        apiKey: "${VLLM_API_KEY}",
        api: "openai-completions",
        request: { allowPrivateNetwork: true },
        timeoutSeconds: 300,
        models: [{ id: "your-model-id", name: "Local vLLM Model" }],
      },
    },
  },
}
timeoutSeconds 仅适用于 vLLM 模型 HTTP 请求,包括连接建立、响应头、响应体流式传输以及总 guarded-fetch 中止。请优先使用它,再考虑增加 agents.defaults.timeoutSeconds,后者控制整个 agent 运行。
检查 vLLM 服务器是否正在运行且可访问:
curl http://127.0.0.1:8000/v1/models
如果你看到连接错误,请验证主机、端口,以及 vLLM 是否以 OpenAI 兼容服务器模式启动。 对于显式 loopback、LAN 或 Tailscale 端点,还要设置 models.providers.vllm.request.allowPrivateNetwork: true;除非显式信任该提供商,否则提供商请求默认会阻止私有网络 URL。
如果请求因认证错误失败,请设置与你服务器配置匹配的真实 VLLM_API_KEY,或在 models.providers.vllm 下显式配置提供商。
如果你的 vLLM 服务器不强制执行认证,VLLM_API_KEY 的任何非空值都可作为 OpenClaw 的选择启用信号。
自动发现要求设置 VLLM_API_KEY。如果你已定义 models.providers.vllm,除非 agents.defaults.models 包含 "vllm/*": {},否则 OpenClaw 只使用你声明的模型。
如果 Qwen 模型打印 JSON/XML 工具语法,而不是执行 skill,请查看上方高级配置中的 Qwen 指南。通常的修复方法是:
  • 使用该模型的正确解析器/模板启动 vLLM
  • 使用 openclaw models list --provider vllm 确认确切模型 ID
  • 仅当 tool_choice: "auto" 仍返回空的或纯文本 tool calls 时,才添加专用的按模型 params.extra_body.tool_choice: "required" 覆盖
更多帮助:故障排除常见问题

相关

模型选择

选择提供商、模型引用和故障转移行为。

OpenAI

原生 OpenAI provider 和 OpenAI 兼容路由行为。

OAuth 和认证

认证详情和凭据复用规则。

故障排除

常见问题及其解决方法。