Skip to main content
构建一个提供商插件,用于向 OpenClaw 添加模型提供商(LLM):模型 目录、API key 认证和动态模型解析。
刚接触 OpenClaw 插件?请先阅读入门指南, 了解软件包结构和清单设置。
提供商插件会把模型添加到 OpenClaw 的常规推理循环中。如果该 模型必须通过原生智能体守护进程运行,并由其管理线程、压缩 或工具事件,请将该提供商与智能体适配运行框架配对, 而不是把守护进程协议细节放进核心。

演练

1

Package and manifest

步骤 1:软件包和清单

{
  "name": "@myorg/openclaw-acme-ai",
  "version": "1.0.0",
  "type": "module",
  "openclaw": {
    "extensions": ["./index.ts"],
    "providers": ["acme-ai"],
    "compat": {
      "pluginApi": ">=2026.3.24-beta.2",
      "minGatewayVersion": "2026.3.24-beta.2"
    },
    "build": {
      "openclawVersion": "2026.3.24-beta.2",
      "pluginSdkVersion": "2026.3.24-beta.2"
    }
  }
}
{
  "id": "acme-ai",
  "name": "Acme AI",
  "description": "Acme AI model provider",
  "providers": ["acme-ai"],
  "modelSupport": {
    "modelPrefixes": ["acme-"]
  },
  "setup": {
    "providers": [
      {
        "id": "acme-ai",
        "envVars": ["ACME_AI_API_KEY"]
      }
    ]
  },
  "providerAuthAliases": {
    "acme-ai-coding": "acme-ai"
  },
  "providerAuthChoices": [
    {
      "provider": "acme-ai",
      "method": "api-key",
      "choiceId": "acme-ai-api-key",
      "choiceLabel": "Acme AI API key",
      "groupId": "acme-ai",
      "groupLabel": "Acme AI",
      "cliFlag": "--acme-ai-api-key",
      "cliOption": "--acme-ai-api-key <key>",
      "cliDescription": "Acme AI API key"
    }
  ],
  "configSchema": {
    "type": "object",
    "additionalProperties": false
  }
}
setup.providers[].envVars 让 OpenClaw 无需加载你的插件运行时即可 检测凭据。当某个提供商变体应复用另一个提供商 id 的认证时,请添加 providerAuthAliasesmodelSupport 是可选项,它允许 OpenClaw 在运行时 钩子存在之前,根据 acme-large 这样的简写模型 id 自动加载你的提供商插件。 package.json 中的 openclaw.compatopenclaw.build 是发布到 ClawHub 所必需的(openclaw.compat.pluginApiopenclaw.build.openclawVersion 是两个必填字段;省略 minGatewayVersion 时会回退到 openclaw.install.minHostVersion)。
2

Register the provider

一个最小文本提供商需要 idlabelauthcatalogcatalog 是由提供商拥有的运行时/配置钩子;它可以调用实时 厂商 API,并返回 models.providers 条目。
index.ts
import { definePluginEntry } from "openclaw/plugin-sdk/plugin-entry";
import { createProviderApiKeyAuthMethod } from "openclaw/plugin-sdk/provider-auth";

export default definePluginEntry({
  id: "acme-ai",
  name: "Acme AI",
  description: "Acme AI model provider",
  register(api) {
    api.registerProvider({
      id: "acme-ai",
      label: "Acme AI",
      docsPath: "/providers/acme-ai",
      envVars: ["ACME_AI_API_KEY"],

      auth: [
        createProviderApiKeyAuthMethod({
          providerId: "acme-ai",
          methodId: "api-key",
          label: "Acme AI API key",
          hint: "API key from your Acme AI dashboard",
          optionKey: "acmeAiApiKey",
          flagName: "--acme-ai-api-key",
          envVar: "ACME_AI_API_KEY",
          promptMessage: "Enter your Acme AI API key",
          defaultModel: "acme-ai/acme-large",
        }),
      ],

      catalog: {
        order: "simple",
        run: async (ctx) => {
          const apiKey =
            ctx.resolveProviderApiKey("acme-ai").apiKey;
          if (!apiKey) return null;
          return {
            provider: {
              baseUrl: "https://api.acme-ai.com/v1",
              apiKey,
              api: "openai-completions",
              models: [
                {
                  id: "acme-large",
                  name: "Acme Large",
                  reasoning: true,
                  input: ["text", "image"],
                  cost: { input: 3, output: 15, cacheRead: 0.3, cacheWrite: 3.75 },
                  contextWindow: 200000,
                  maxTokens: 32768,
                },
                {
                  id: "acme-small",
                  name: "Acme Small",
                  reasoning: false,
                  input: ["text"],
                  cost: { input: 1, output: 5, cacheRead: 0.1, cacheWrite: 1.25 },
                  contextWindow: 128000,
                  maxTokens: 8192,
                },
              ],
            },
          };
        },
      },
    });

    api.registerModelCatalogProvider({
      provider: "acme-ai",
      kinds: ["text"],
      liveCatalog: async (ctx) => {
        const apiKey = ctx.resolveProviderApiKey("acme-ai").apiKey;
        if (!apiKey) return null;
        return [
          {
            kind: "text",
            provider: "acme-ai",
            model: "acme-large",
            label: "Acme Large",
            source: "live",
          },
        ];
      },
    });
  },
});
registerModelCatalogProvider 是较新的控制平面目录表面, 用于列表/帮助/选择器 UI,覆盖 textvoiceimage_generationvideo_generationmusic_generation 行。请将厂商端点调用和响应映射保留在插件中; OpenClaw 负责共享的行形状、来源标签和帮助渲染。这就是一个可工作的提供商。用户现在可以运行 openclaw onboard --acme-ai-api-key <key>,并选择 acme-ai/acme-large 作为他们的模型。

实时模型发现

如果你的提供商暴露 /models 风格的 API,请将提供商特定的 端点和行投影保留在你的插件中,并使用 openclaw/plugin-sdk/provider-catalog-live-runtime 处理共享的抓取 生命周期。该辅助工具提供受保护的 HTTP 抓取、提供商认证标头、 结构化 HTTP 错误、TTL 缓存和静态回退行为,而无需把 提供商策略放进 OpenClaw 核心。当实时 API 只告诉你哪些由提供商拥有的静态目录行当前可用时, 使用 buildLiveModelProviderConfig
index.ts
import { definePluginEntry } from "openclaw/plugin-sdk/plugin-entry";
import {
  buildLiveModelProviderConfig,
  type LiveModelCatalogFetchGuard,
} from "openclaw/plugin-sdk/provider-catalog-live-runtime";

const STATIC_MODELS = [
  {
    id: "acme-large",
    name: "Acme Large",
    reasoning: true,
    input: ["text", "image"],
    cost: { input: 3, output: 15, cacheRead: 0.3, cacheWrite: 3.75 },
    contextWindow: 200000,
    maxTokens: 32768,
  },
  {
    id: "acme-small",
    name: "Acme Small",
    reasoning: false,
    input: ["text"],
    cost: { input: 1, output: 5, cacheRead: 0.1, cacheWrite: 1.25 },
    contextWindow: 128000,
    maxTokens: 8192,
  },
] as const;

async function buildAcmeLiveProvider(params: {
  apiKey: string;
  discoveryApiKey?: string;
  fetchGuard?: LiveModelCatalogFetchGuard;
}) {
  return await buildLiveModelProviderConfig({
    providerId: "acme-ai",
    endpoint: "https://api.acme-ai.com/v1/models",
    providerConfig: {
      baseUrl: "https://api.acme-ai.com/v1",
      api: "openai-completions",
    },
    models: STATIC_MODELS,
    apiKey: params.apiKey,
    discoveryApiKey: params.discoveryApiKey,
    fetchGuard: params.fetchGuard,
    ttlMs: 60_000,
    auditContext: "acme-ai-model-discovery",
  });
}

export default definePluginEntry({
  id: "acme-ai",
  name: "Acme AI",
  register(api) {
    api.registerProvider({
      id: "acme-ai",
      label: "Acme AI",
      catalog: {
        order: "simple",
        run: async (ctx) => {
          const auth = ctx.resolveProviderAuth("acme-ai");
          const apiKey =
            auth.apiKey ?? ctx.resolveProviderApiKey("acme-ai").apiKey;
          if (!apiKey) return null;
          return {
            provider: await buildAcmeLiveProvider({
              apiKey,
              discoveryApiKey: auth.discoveryApiKey,
            }),
          };
        },
      },
      staticCatalog: {
        order: "simple",
        run: async () => ({
          provider: {
            baseUrl: "https://api.acme-ai.com/v1",
            api: "openai-completions",
            models: [...STATIC_MODELS],
          },
        }),
      },
    });
  },
});
当提供商 API 返回更丰富的元数据,并且插件需要自行将行投影为 OpenClaw 模型定义时,使用 getCachedLiveProviderModelRows
index.ts
import {
  getCachedLiveProviderModelRows,
  LiveModelCatalogHttpError,
} from "openclaw/plugin-sdk/provider-catalog-live-runtime";

async function discoverAcmeModels(apiKey: string) {
  try {
    const rows = await getCachedLiveProviderModelRows({
      providerId: "acme-ai",
      endpoint: "https://api.acme-ai.com/v1/models",
      apiKey,
      ttlMs: 60_000,
      auditContext: "acme-ai-model-discovery",
    });
    return rows
      .map((row) => projectAcmeModel(row))
      .filter((model) => model !== null);
  } catch (error) {
    if (error instanceof LiveModelCatalogHttpError) {
      return STATIC_MODELS;
    }
    throw error;
  }
}
run 应保持由认证把关,并在没有可用凭据时返回 null。 保留离线 staticRun 或静态回退,使设置、文档、 测试和选择器表面不依赖实时网络访问。使用适合模型列表新鲜度的 TTL, 避免请求时文件系统轮询;仅当上游响应不是 OpenAI 兼容的 { data: [{ id, object }] } 形状时,才传入提供商特定的 readRows / readModelId如果上游提供商使用的控制标记与 OpenClaw 不同,请添加一个 小型双向文本转换,而不是替换流路径:
api.registerTextTransforms({
  input: [
    { from: /red basket/g, to: "blue basket" },
    { from: /paper ticket/g, to: "digital ticket" },
    { from: /left shelf/g, to: "right shelf" },
  ],
  output: [
    { from: /blue basket/g, to: "red basket" },
    { from: /digital ticket/g, to: "paper ticket" },
    { from: /right shelf/g, to: "left shelf" },
  ],
});
input 会在传输前重写最终系统提示和文本消息内容。 output 会在 OpenClaw 解析自己的控制标记或渠道投递之前, 重写助手文本增量和最终文本。对于只注册一个带 API key 认证以及单个目录支持运行时的文本提供商的 内置提供商,优先使用范围更窄的 defineSingleProviderPluginEntry(...) 辅助工具:
import { defineSingleProviderPluginEntry } from "openclaw/plugin-sdk/provider-entry";

export default defineSingleProviderPluginEntry({
  id: "acme-ai",
  name: "Acme AI",
  description: "Acme AI model provider",
  provider: {
    label: "Acme AI",
    docsPath: "/providers/acme-ai",
    auth: [
      {
        methodId: "api-key",
        label: "Acme AI API key",
        hint: "API key from your Acme AI dashboard",
        optionKey: "acmeAiApiKey",
        flagName: "--acme-ai-api-key",
        envVar: "ACME_AI_API_KEY",
        promptMessage: "Enter your Acme AI API key",
        defaultModel: "acme-ai/acme-large",
      },
    ],
    catalog: {
      buildProvider: () => ({
        api: "openai-completions",
        baseUrl: "https://api.acme-ai.com/v1",
        models: [{ id: "acme-large", name: "Acme Large" }],
      }),
      buildStaticProvider: () => ({
        api: "openai-completions",
        baseUrl: "https://api.acme-ai.com/v1",
        models: [{ id: "acme-large", name: "Acme Large" }],
      }),
    },
  },
});
buildProvider 是实时目录路径,在 OpenClaw 可以解析真实 提供商凭证时使用。它可以执行提供商特定的发现。只有在配置凭证前 可以安全展示的离线行中才使用 buildStaticProvider;它不得需要凭据或发起网络请求。 OpenClaw 的 models list --all 显示目前只会以空配置、空环境变量且无 智能体/工作区路径的方式执行内置提供商插件的静态目录。如果你的凭证流程还需要在新手引导期间修补 models.providers.*、别名以及 智能体默认模型,请使用来自 openclaw/plugin-sdk/provider-onboard 的预设辅助函数。范围最窄的辅助函数是 createDefaultModelPresetAppliers(...)createDefaultModelsPresetAppliers(...)createModelCatalogPresetAppliers(...)当提供商的原生端点在常规 openai-completions 传输上支持流式 usage 块时, 优先使用 openclaw/plugin-sdk/provider-catalog-shared 中的共享目录辅助函数, 而不是硬编码提供商 ID 检查。supportsNativeStreamingUsageCompat(...)applyProviderNativeStreamingUsageCompat(...) 会从端点能力映射中检测支持情况, 因此即使插件使用自定义提供商 ID,原生 Moonshot/DashScope 风格端点仍会选择启用。上面的实时发现示例覆盖 /models 风格的提供商 API。请将该发现保留在 catalog.run 中,并以可用凭证作为门控,同时保持 staticRun 不访问网络,以便生成离线目录。
3

Add dynamic model resolution

如果你的提供商接受任意模型 ID(例如代理或路由器), 请添加 resolveDynamicModel
api.registerProvider({
  // ... id, label, auth, catalog from above

  resolveDynamicModel: (ctx) => ({
    id: ctx.modelId,
    name: ctx.modelId,
    provider: "acme-ai",
    api: "openai-completions",
    baseUrl: "https://api.acme-ai.com/v1",
    reasoning: false,
    input: ["text"],
    cost: { input: 0, output: 0, cacheRead: 0, cacheWrite: 0 },
    contextWindow: 128000,
    maxTokens: 8192,
  }),
});
如果解析需要网络调用,请使用 prepareDynamicModel 进行异步预热 - 它完成后会再次运行 resolveDynamicModel
4

Add runtime hooks (as needed)

大多数提供商只需要 catalog + resolveDynamicModel。请随着提供商需求逐步添加钩子。共享辅助构建器现在覆盖最常见的重放/工具兼容系列, 因此插件通常不需要逐个手动接线每个钩子:
import { buildProviderReplayFamilyHooks } from "openclaw/plugin-sdk/provider-model-shared";
import { buildProviderStreamFamilyHooks } from "openclaw/plugin-sdk/provider-stream";
import { buildProviderToolCompatFamilyHooks } from "openclaw/plugin-sdk/provider-tools";

const GOOGLE_FAMILY_HOOKS = {
  ...buildProviderReplayFamilyHooks({ family: "google-gemini" }),
  ...buildProviderStreamFamilyHooks("google-thinking"),
  ...buildProviderToolCompatFamilyHooks("gemini"),
};

api.registerProvider({
  id: "acme-gemini-compatible",
  // ...
  ...GOOGLE_FAMILY_HOOKS,
});
当前可用的重放系列:
系列接入内容内置示例
openai-compatible面向 OpenAI 兼容传输的共享 OpenAI 风格重放策略,包括工具调用 ID 清理、assistant 优先顺序修复,以及传输需要时的通用 Gemini 轮次验证moonshot, ollama, xai, zai
anthropic-by-modelmodelId 选择的 Claude 感知重放策略,因此 Anthropic 消息传输只有在解析出的模型确实是 Claude ID 时才获得 Claude 特定的 thinking 块清理amazon-bedrock
native-anthropic-by-modelanthropic-by-model 相同的按模型选择 Claude 策略,外加工具调用 ID 清理,以及面向必须保留供应商原生 ID 的传输的原生 Anthropic 工具使用 ID 保留anthropic-vertex, clawrouter
google-gemini原生 Gemini 重放策略以及引导重放清理。共享系列让文本输出 Gemini CLI 保持标记式推理;直接的 google 提供商会将 resolveReasoningOutputMode 覆盖为 native,因为 Gemini API thinking 会作为原生 thought parts 到达。google, google-gemini-cli
passthrough-gemini面向通过 OpenAI 兼容代理传输运行的 Gemini 模型的 Gemini 思维签名清理;不会启用原生 Gemini 重放验证或引导重写openrouter, kilocode, opencode, opencode-go
hybrid-anthropic-openai面向在一个插件中混合 Anthropic 消息和 OpenAI 兼容模型表面的提供商的混合策略;可选的仅 Claude thinking 块丢弃仍限定在 Anthropic 侧minimax
当前可用的流系列:
系列接入内容内置示例
google-thinking共享流路径上的 Gemini thinking 负载规范化google, google-gemini-cli
kilocode-thinking共享代理流路径上的 Kilo 推理包装器,其中 kilo/auto 和不受支持的代理推理 ID 会跳过注入的 thinkingkilocode
moonshot-thinking从配置 + /think 级别映射 Moonshot 二进制原生 thinking 负载moonshot
minimax-fast-mode共享流路径上的 MiniMax 快速模式模型重写minimax, minimax-portal
openai-responses-defaults共享原生 OpenAI/Codex Responses 包装器:归因标头、/fast/serviceTier、文本详细程度、原生 Codex Web 搜索、推理兼容负载整形,以及 Responses 上下文管理openai
openrouter-thinking面向代理路由的 OpenRouter 推理包装器,其中不受支持模型/auto 跳过会集中处理openrouter
tool-stream-default-on面向 Z.AI 这类希望默认启用工具流式传输、除非明确禁用的提供商的默认启用 tool_stream 包装器zai
每个系列构建器都由同一包导出的较低层公共辅助函数组成,当某个提供商需要偏离常见模式时,你可以使用它们:
  • openclaw/plugin-sdk/provider-model-shared - ProviderReplayFamilybuildProviderReplayFamilyHooks(...),以及原始重放构建器(buildOpenAICompatibleReplayPolicybuildAnthropicReplayPolicyForModelbuildGoogleGeminiReplayPolicybuildHybridAnthropicOrOpenAIReplayPolicy)。还导出 Gemini 重放辅助函数(sanitizeGoogleGeminiReplayHistoryresolveTaggedReasoningOutputMode)以及端点/模型辅助函数(resolveProviderEndpointnormalizeProviderIdnormalizeGooglePreviewModelId)。
  • openclaw/plugin-sdk/provider-stream - ProviderStreamFamilybuildProviderStreamFamilyHooks(...)composeProviderStreamWrappers(...),以及共享 OpenAI/Codex 包装器(createOpenAIAttributionHeadersWrappercreateOpenAIFastModeWrappercreateOpenAIServiceTierWrappercreateOpenAIResponsesContextManagementWrappercreateCodexNativeWebSearchWrapper)、DeepSeek V4 OpenAI 兼容包装器(createDeepSeekV4OpenAICompatibleThinkingWrapper)、Anthropic Messages thinking 预填充清理(createAnthropicThinkingPrefillPayloadWrapper)、纯文本工具调用兼容(createPlainTextToolCallCompatWrapper),以及共享代理/提供商包装器(createOpenRouterWrappercreateToolStreamWrappercreateMinimaxFastModeWrapper)。
  • openclaw/plugin-sdk/provider-stream-shared - 面向热提供商路径的轻量负载和事件包装器,包括 createOpenAICompatibleCompletionsThinkingOffWrappercreatePayloadPatchStreamWrappercreatePlainTextToolCallCompatWrappernormalizeOpenAICompatibleReasoningPayload(...)setQwenChatTemplateThinking(...)
  • openclaw/plugin-sdk/provider-tools - ProviderToolCompatFamilybuildProviderToolCompatFamilyHooks("deepseek" | "gemini" | "openai"),以及底层提供商 schema 辅助函数。
对于 Gemini 系列提供商,请保持推理输出模式与 传输对齐。直接的 Google Gemini API 提供商应使用 native 推理输出,让 OpenClaw 消费原生 thought parts,而无需添加 <think> / <final> prompt 指令。仅文本的 Gemini CLI 风格 后端如果解析最终 JSON/文本响应,可以保留共享的 google-gemini 标记式契约。有些流辅助函数有意保持在提供商本地。@openclaw/anthropic-providerwrapAnthropicProviderStreamresolveAnthropicBetasresolveAnthropicFastModeresolveAnthropicServiceTier 以及较低层的 Anthropic 包装器构建器保留在自己的公共 api.ts / contract-api.ts 接缝中,因为它们编码了 Claude OAuth beta 处理和 context1m 门控。xAI 插件同样将原生 xAI Responses 整形保留在自己的 wrapStreamFn 中(/fast 别名、默认 tool_stream、不受支持的严格工具清理、xAI 特定的推理负载移除)。同样的包根模式也支撑 @openclaw/openai-provider(提供商构建器、默认模型辅助函数、实时提供商构建器)和 @openclaw/openrouter-provider(提供商构建器以及新手引导/配置辅助函数)。
对于每次推理调用前都需要令牌交换的提供商:
prepareRuntimeAuth: async (ctx) => {
  const exchanged = await exchangeToken(ctx.apiKey);
  return {
    apiKey: exchanged.token,
    baseUrl: exchanged.baseUrl,
    expiresAt: exchanged.expiresAt,
  };
},
对于模型/提供商插件,OpenClaw 大致按此顺序调用钩子。大多数提供商只使用 2-3 个。这不是完整的 ProviderPlugin 契约;请参阅 内部机制:提供商运行时钩子,获取完整且当前准确的钩子列表和回退说明。仅为兼容而保留、OpenClaw 不再调用的提供商字段不会在此列出,例如 ProviderPlugin.capabilitiessuppressBuiltInModel
钩子使用时机
catalog模型目录或基础 URL 默认值
applyConfigDefaults配置物化期间由提供商拥有的全局默认值
normalizeModelId查找前清理旧版/预览模型 ID 别名
normalizeTransport通用模型组装前清理提供商族的 api / baseUrl
normalizeConfig规范化 models.providers.<id> 配置
applyNativeStreamingUsageCompat面向配置提供商的原生流式用量兼容重写
resolveConfigApiKey提供商拥有的环境标记认证解析
resolveSyntheticAuth本地/自托管或配置支持的合成认证
resolveExternalAuthProfiles为 CLI/应用管理的凭证叠加提供商拥有的外部认证配置档案
shouldDeferSyntheticProfileAuth将合成的已存储配置档案占位符置于环境/配置认证之后
resolveDynamicModel接受任意上游模型 ID
prepareDynamicModel解析前异步获取元数据
normalizeResolvedModel运行器前的传输重写
normalizeToolSchemas注册前由提供商拥有的工具 schema 清理
inspectToolSchemas提供商拥有的工具 schema 诊断
resolveReasoningOutputMode带标签与原生推理输出契约
prepareExtraParams默认请求参数
createStreamFn完全自定义的 StreamFn 传输
wrapStreamFn常规流路径上的自定义标头/正文包装器
resolveTransportTurnState原生逐轮标头/元数据
resolveWebSocketSessionPolicy原生 WS 会话标头/冷却时间
formatApiKey自定义运行时令牌结构
refreshOAuth自定义 OAuth 刷新
buildAuthDoctorHint认证修复指引
matchesContextOverflowError提供商拥有的溢出检测
classifyFailoverReason提供商拥有的速率限制/过载分类
isCacheTtlEligible提示缓存 TTL 门控
buildMissingAuthMessage自定义缺失认证提示
augmentModelCatalog合成前向兼容行(已弃用,请优先使用 registerModelCatalogProvider
resolveThinkingProfile模型特定的 /think 选项集
isBinaryThinking二元思考开/关兼容性(已弃用,请优先使用 resolveThinkingProfile
supportsXHighThinkingxhigh 推理支持兼容性(已弃用,请优先使用 resolveThinkingProfile
resolveDefaultThinkingLevel默认 /think 策略兼容性(已弃用,请优先使用 resolveThinkingProfile
isModernModelRef实时/冒烟模型匹配
prepareRuntimeAuth推理前的令牌交换
resolveUsageAuth自定义用量凭证解析
fetchUsageSnapshot自定义用量端点
createEmbeddingProvider提供商拥有的、用于记忆/搜索的嵌入适配器
buildReplayPolicy自定义转录回放/压缩策略
sanitizeReplayHistory通用清理后的提供商特定回放重写
validateReplayTurns嵌入式运行器前的严格回放轮次验证
onModelSelected选择后的回调(例如遥测)
运行时回退说明:
  • normalizeConfig 为每个提供商 ID 解析一个拥有方插件(先是内置提供商,然后是匹配的运行时插件),并且只调用该钩子;不会扫描其他提供商。Google 自己的 normalizeConfig 钩子会规范化 google / google-vertex / google-antigravity 配置条目;它不是单独的核心回退。
  • resolveConfigApiKey 在公开时使用提供商钩子。Amazon Bedrock 将 AWS 环境标记解析保留在其提供商插件中;配置为 auth: "aws-sdk" 时,运行时认证本身仍使用 AWS SDK 默认链。
  • resolveThinkingProfile(ctx) 接收已选择的 providermodelId、可选的合并后 reasoning 目录提示,以及可选的合并后模型 compat 事实。仅使用 compat 选择该提供商的思考 UI/配置档案。
  • resolveSystemPromptContribution 允许提供商为某个模型族注入缓存感知的系统提示指引。当行为属于单个提供商/模型族并且应保留稳定/动态缓存拆分时,优先使用它,而不是旧版插件范围的 before_prompt_build 钩子。
5

添加额外能力(可选)

步骤 5:添加额外能力

提供商插件可以在文本推理之外注册嵌入、语音、实时转录、实时语音、媒体理解、图像生成、视频生成、Web 获取和 Web 搜索。OpenClaw 将其归类为混合能力插件,这是公司插件的推荐模式(每个厂商一个插件)。请参阅内部机制:能力所有权register(api) 中注册每项能力,并与你现有的 api.registerProvider(...) 调用放在一起。只选择你需要的标签页:
import {
  assertOkOrThrowProviderError,
  postJsonRequest,
} from "openclaw/plugin-sdk/provider-http";

api.registerSpeechProvider({
  id: "acme-ai",
  label: "Acme Speech",
  defaultTimeoutMs: 120_000,
  isConfigured: ({ config }) => Boolean(config.messages?.tts),
  synthesize: async (req) => {
    const { response, release } = await postJsonRequest({
      url: "https://api.example.com/v1/speech",
      headers: new Headers({ "Content-Type": "application/json" }),
      body: { text: req.text },
      timeoutMs: req.timeoutMs,
      fetchFn: fetch,
      auditContext: "acme speech",
    });
    try {
      await assertOkOrThrowProviderError(response, "Acme Speech API error");
      return {
        audioBuffer: Buffer.from(await response.arrayBuffer()),
        outputFormat: "mp3",
        fileExtension: ".mp3",
        voiceCompatible: false,
      };
    } finally {
      await release();
    }
  },
});
对提供商 HTTP 失败使用 assertOkOrThrowProviderError(...),这样插件就能共享受限的错误正文读取、JSON 错误解析和请求 ID 后缀。
6

Test

步骤 6:测试

src/provider.test.ts
import { describe, it, expect } from "vitest";
// Export your provider config object from index.ts or a dedicated file
import { acmeProvider } from "./provider.js";

describe("acme-ai provider", () => {
  it("resolves dynamic models", () => {
    const model = acmeProvider.resolveDynamicModel!({
      modelId: "acme-beta-v3",
    } as any);
    expect(model.id).toBe("acme-beta-v3");
    expect(model.provider).toBe("acme-ai");
  });

  it("returns catalog when key is available", async () => {
    const result = await acmeProvider.catalog!.run({
      resolveProviderApiKey: () => ({ apiKey: "test-key" }),
    } as any);
    expect(result?.provider?.models).toHaveLength(2);
  });

  it("returns null catalog when no key", async () => {
    const result = await acmeProvider.catalog!.run({
      resolveProviderApiKey: () => ({ apiKey: undefined }),
    } as any);
    expect(result).toBeNull();
  });
});

发布到 ClawHub

提供商插件的发布方式与任何其他外部代码插件相同:
clawhub package publish your-org/your-plugin --dry-run
clawhub package publish your-org/your-plugin
clawhub skill publish <path> 是用于发布技能文件夹的另一个命令, 不是插件包,请不要在这里使用它。

文件结构

<bundled-plugin-root>/acme-ai/
├── package.json              # openclaw.providers metadata
├── openclaw.plugin.json      # Manifest with provider auth metadata
├── index.ts                  # definePluginEntry + registerProvider
└── src/
    ├── provider.test.ts      # Tests
    └── usage.ts              # Usage endpoint (optional)

目录顺序参考

catalog.order 控制你的目录相对于内置提供商何时合并:
顺序时机使用场景
simple第一轮普通 API key 提供商
profilesimple 之后受凭证配置文件门控的提供商
pairedprofile 之后合成多个相关条目
late最后一轮覆盖现有提供商(冲突时胜出)

后续步骤

相关内容