Kilo Gateway 提供商集成设计

概述

本文档描述了如何将”Kilo Gateway”作为一等提供商集成到 OpenClaw 中，整体设计参考了现有的 OpenRouter 实现。Kilo Gateway 使用兼容 OpenAI 的 completions API，只是 base URL 不同。

设计决策

1. 提供商命名

建议：kilocode

理由：

  • 与用户配置示例一致（kilocode 作为提供商 key）
  • 符合现有的命名习惯（如 openrouter、opencode、moonshot）
  • 简洁好记
  • 避免与通用的”kilo”或”gateway”混淆

备选方案：kilo-gateway —— 否决了，因为代码库中很少用连字符命名，kilocode 更简练。

2. 默认模型引用

建议：kilocode/anthropic/claude-opus-4.6

理由：

  • 基于用户配置示例
  • Claude Opus 4.5 是一个很强的默认模型
  • 显式选择模型，避免依赖自动路由

3. Base URL 配置

建议：硬编码默认值 + 配置覆盖

  • 默认 Base URL： https://api.kilo.ai/api/gateway/
  • 可配置： 是，通过 models.providers.kilocode.baseUrl

这与 Moonshot、Venice、Synthetic 等其他提供商的模式一致。

4. 模型扫描

建议：初期不设专门的模型扫描端点

理由：

  • Kilo Gateway 代理到 OpenRouter，模型是动态的
  • 用户可以在配置中手动添加模型
  • 如果 Kilo Gateway 将来暴露 /models 端点，可以再加扫描支持

5. 特殊处理

建议：对 Anthropic 模型沿用 OpenRouter 的行为

既然 Kilo Gateway 代理到 OpenRouter，应该复用相同的特殊处理：

  • anthropic/* 模型的 Cache TTL 资格判定
  • anthropic/* 模型的额外参数（cacheControlTtl）
  • Transcript 策略沿用 OpenRouter 的模式

需要修改的文件

核心凭据管理

1. src/commands/onboard-auth.credentials.ts

添加：

export const KILOCODE_DEFAULT_MODEL_REF = "kilocode/anthropic/claude-opus-4.6";

export async function setKilocodeApiKey(key: string, agentDir?: string) {
  upsertAuthProfile({
    profileId: "kilocode:default",
    credential: {
      type: "api_key",
      provider: "kilocode",
      key,
    },
    agentDir: resolveAuthAgentDir(agentDir),
  });
}

2. src/agents/model-auth.ts

在 resolveEnvApiKey() 的 envMap 中添加：

const envMap: Record<string, string> = {
  // ... 已有条目
  kilocode: "KILOCODE_API_KEY",
};

3. src/config/io.ts

添加到 SHELL_ENV_EXPECTED_KEYS：

const SHELL_ENV_EXPECTED_KEYS = [
  // ... 已有条目
  "KILOCODE_API_KEY",
];

配置应用

4. src/commands/onboard-auth.config-core.ts

添加新函数：

export const KILOCODE_BASE_URL = "https://api.kilo.ai/api/gateway/";

export function applyKilocodeProviderConfig(cfg: OpenClawConfig): OpenClawConfig {
  const models = { ...cfg.agents?.defaults?.models };
  models[KILOCODE_DEFAULT_MODEL_REF] = {
    ...models[KILOCODE_DEFAULT_MODEL_REF],
    alias: models[KILOCODE_DEFAULT_MODEL_REF]?.alias ?? "Kilo Gateway",
  };

  const providers = { ...cfg.models?.providers };
  const existingProvider = providers.kilocode;
  const { apiKey: existingApiKey, ...existingProviderRest } = (existingProvider ?? {}) as Record<
    string,
    unknown
  > as { apiKey?: string };
  const resolvedApiKey = typeof existingApiKey === "string" ? existingApiKey : undefined;
  const normalizedApiKey = resolvedApiKey?.trim();

  providers.kilocode = {
    ...existingProviderRest,
    baseUrl: KILOCODE_BASE_URL,
    api: "openai-completions",
    ...(normalizedApiKey ? { apiKey: normalizedApiKey } : {}),
  };

  return {
    ...cfg,
    agents: {
      ...cfg.agents,
      defaults: {
        ...cfg.agents?.defaults,
        models,
      },
    },
    models: {
      mode: cfg.models?.mode ?? "merge",
      providers,
    },
  };
}

export function applyKilocodeConfig(cfg: OpenClawConfig): OpenClawConfig {
  const next = applyKilocodeProviderConfig(cfg);
  const existingModel = next.agents?.defaults?.model;
  return {
    ...next,
    agents: {
      ...next.agents,
      defaults: {
        ...next.agents?.defaults,
        model: {
          ...(existingModel && "fallbacks" in (existingModel as Record<string, unknown>)
            ? {
                fallbacks: (existingModel as { fallbacks?: string[] }).fallbacks,
              }
            : undefined),
          primary: KILOCODE_DEFAULT_MODEL_REF,
        },
      },
    },
  };
}

认证选择系统

5. src/commands/onboard-types.ts

在 AuthChoice 类型中添加：

export type AuthChoice =
  // ... 已有选项
  "kilocode-api-key";
// ...

在 OnboardOptions 中添加：

export type OnboardOptions = {
  // ... 已有选项
  kilocodeApiKey?: string;
  // ...
};

6. src/commands/auth-choice-options.ts

在 AuthChoiceGroupId 中添加：

export type AuthChoiceGroupId =
  // ... 已有分组
  "kilocode";
// ...

在 AUTH_CHOICE_GROUP_DEFS 中添加：

{
  value: "kilocode",
  label: "Kilo Gateway",
  hint: "API key (OpenRouter-compatible)",
  choices: ["kilocode-api-key"],
},

在 buildAuthChoiceOptions() 中添加：

options.push({
  value: "kilocode-api-key",
  label: "Kilo Gateway API key",
  hint: "OpenRouter-compatible gateway",
});

7. src/commands/auth-choice.preferred-provider.ts

添加映射：

const PREFERRED_PROVIDER_BY_AUTH_CHOICE: Partial<Record<AuthChoice, string>> = {
  // ... 已有映射
  "kilocode-api-key": "kilocode",
};

认证选择应用

8. src/commands/auth-choice.apply.api-providers.ts

添加导入：

import {
  // ... 已有导入
  applyKilocodeConfig,
  applyKilocodeProviderConfig,
  KILOCODE_DEFAULT_MODEL_REF,
  setKilocodeApiKey,
} from "./onboard-auth.js";

添加 kilocode-api-key 的处理逻辑：

if (authChoice === "kilocode-api-key") {
  const store = ensureAuthProfileStore(params.agentDir, {
    allowKeychainPrompt: false,
  });
  const profileOrder = resolveAuthProfileOrder({
    cfg: nextConfig,
    store,
    provider: "kilocode",
  });
  const existingProfileId = profileOrder.find((profileId) => Boolean(store.profiles[profileId]));
  const existingCred = existingProfileId ? store.profiles[existingProfileId] : undefined;
  let profileId = "kilocode:default";
  let mode: "api_key" | "oauth" | "token" = "api_key";
  let hasCredential = false;

  if (existingProfileId && existingCred?.type) {
    profileId = existingProfileId;
    mode =
      existingCred.type === "oauth" ? "oauth" : existingCred.type === "token" ? "token" : "api_key";
    hasCredential = true;
  }

  if (!hasCredential && params.opts?.token && params.opts?.tokenProvider === "kilocode") {
    await setKilocodeApiKey(normalizeApiKeyInput(params.opts.token), params.agentDir);
    hasCredential = true;
  }

  if (!hasCredential) {
    const envKey = resolveEnvApiKey("kilocode");
    if (envKey) {
      const useExisting = await params.prompter.confirm({
        message: `Use existing KILOCODE_API_KEY (${envKey.source}, ${formatApiKeyPreview(envKey.apiKey)})?`,
        initialValue: true,
      });
      if (useExisting) {
        await setKilocodeApiKey(envKey.apiKey, params.agentDir);
        hasCredential = true;
      }
    }
  }

  if (!hasCredential) {
    const key = await params.prompter.text({
      message: "Enter Kilo Gateway API key",
      validate: validateApiKeyInput,
    });
    await setKilocodeApiKey(normalizeApiKeyInput(String(key)), params.agentDir);
    hasCredential = true;
  }

  if (hasCredential) {
    nextConfig = applyAuthProfileConfig(nextConfig, {
      profileId,
      provider: "kilocode",
      mode,
    });
  }
  {
    const applied = await applyDefaultModelChoice({
      config: nextConfig,
      setDefaultModel: params.setDefaultModel,
      defaultModel: KILOCODE_DEFAULT_MODEL_REF,
      applyDefaultConfig: applyKilocodeConfig,
      applyProviderConfig: applyKilocodeProviderConfig,
      noteDefault: KILOCODE_DEFAULT_MODEL_REF,
      noteAgentModel,
      prompter: params.prompter,
    });
    nextConfig = applied.config;
    agentModelOverride = applied.agentModelOverride ?? agentModelOverride;
  }
  return { config: nextConfig, agentModelOverride };
}

同时在函数顶部添加 tokenProvider 映射：

if (params.opts.tokenProvider === "kilocode") {
  authChoice = "kilocode-api-key";
}

CLI 注册

9. src/cli/program/register.onboard.ts

添加 CLI 选项：

.option("--kilocode-api-key <key>", "Kilo Gateway API key")

在 action handler 中添加：

kilocodeApiKey: opts.kilocodeApiKey as string | undefined,

更新 auth-choice 帮助文本：

.option(
  "--auth-choice <choice>",
  "Auth: setup-token|token|chutes|openai-codex|openai-api-key|openrouter-api-key|kilocode-api-key|ai-gateway-api-key|...",
)

非交互式引导

10. src/commands/onboard-non-interactive/local/auth-choice.ts

添加 kilocode-api-key 的处理：

if (authChoice === "kilocode-api-key") {
  const resolved = await resolveNonInteractiveApiKey({
    provider: "kilocode",
    cfg: baseConfig,
    flagValue: opts.kilocodeApiKey,
    flagName: "--kilocode-api-key",
    envVar: "KILOCODE_API_KEY",
  });
  await setKilocodeApiKey(resolved.apiKey, agentDir);
  nextConfig = applyAuthProfileConfig(nextConfig, {
    profileId: "kilocode:default",
    provider: "kilocode",
    mode: "api_key",
  });
  // ... 应用默认模型
}

导出更新

11. src/commands/onboard-auth.ts

添加导出：

export {
  // ... 已有导出
  applyKilocodeConfig,
  applyKilocodeProviderConfig,
  KILOCODE_BASE_URL,
} from "./onboard-auth.config-core.js";

export {
  // ... 已有导出
  KILOCODE_DEFAULT_MODEL_REF,
  setKilocodeApiKey,
} from "./onboard-auth.credentials.js";

特殊处理（可选）

12. src/agents/pi-embedded-runner/cache-ttl.ts

为 Kilo Gateway 的 Anthropic 模型添加支持：

export function isCacheTtlEligibleProvider(provider: string, modelId: string): boolean {
  const normalizedProvider = provider.toLowerCase();
  const normalizedModelId = modelId.toLowerCase();
  if (normalizedProvider === "anthropic") return true;
  if (normalizedProvider === "openrouter" && normalizedModelId.startsWith("anthropic/"))
    return true;
  if (normalizedProvider === "kilocode" && normalizedModelId.startsWith("anthropic/")) return true;
  return false;
}

13. src/agents/transcript-policy.ts

添加 Kilo Gateway 处理（类似 OpenRouter）：

const isKilocodeGemini = provider === "kilocode" && modelId.toLowerCase().includes("gemini");

// 加入 needsNonImageSanitize 检查
const needsNonImageSanitize =
  isGoogle || isAnthropic || isMistral || isOpenRouterGemini || isKilocodeGemini;

配置结构

用户配置示例

{
  "models": {
    "mode": "merge",
    "providers": {
      "kilocode": {
        "baseUrl": "https://api.kilo.ai/api/gateway/",
        "apiKey": "xxxxx",
        "api": "openai-completions",
        "models": [
          {
            "id": "anthropic/claude-opus-4.6",
            "name": "Anthropic: Claude Opus 4.6"
          },
          { "id": "minimax/minimax-m2.5:free", "name": "Minimax: Minimax M2.5" }
        ]
      }
    }
  }
}

认证 Profile 结构

{
  "profiles": {
    "kilocode:default": {
      "type": "api_key",
      "provider": "kilocode",
      "key": "xxxxx"
    }
  }
}

测试要点

  1. 单元测试：

    • 测试 setKilocodeApiKey() 写入正确的 profile
    • 测试 applyKilocodeConfig() 设置正确的默认值
    • 测试 resolveEnvApiKey("kilocode") 返回正确的环境变量

  2. 集成测试：

    • 测试使用 --auth-choice kilocode-api-key 的引导流程
    • 测试使用 --kilocode-api-key 的非交互式引导
    • 测试 kilocode/ 前缀的模型选择

  3. 端到端测试：

    • 通过 Kilo Gateway 的实际 API 调用测试（在线测试）

迁移说明

  • 现有用户无需迁移
  • 新用户可以直接使用 kilocode-api-key 认证方式
  • 已有的 kilocode 提供商手动配置将继续正常工作

后续展望

  1. 模型目录： 如果 Kilo Gateway 暴露 /models 端点，参考 scanOpenRouterModels() 添加扫描支持

  2. OAuth 支持： 如果 Kilo Gateway 添加 OAuth，相应扩展认证系统

  3. 速率限制： 如有需要，考虑添加 Kilo Gateway 专属的速率限制处理

  4. 文档： 在 docs/providers/kilocode.md 添加设置和使用说明

变更汇总

文件变更类型描述
src/commands/onboard-auth.credentials.ts新增KILOCODE_DEFAULT_MODEL_REF、setKilocodeApiKey()
src/agents/model-auth.ts修改在 envMap 中添加 kilocode
src/config/io.ts修改在 shell env keys 中添加 KILOCODE_API_KEY
src/commands/onboard-auth.config-core.ts新增applyKilocodeProviderConfig()、applyKilocodeConfig()
src/commands/onboard-types.ts修改在 AuthChoice 中添加 kilocode-api-key，在选项中添加 kilocodeApiKey
src/commands/auth-choice-options.ts修改添加 kilocode 分组和选项
src/commands/auth-choice.preferred-provider.ts修改添加 kilocode-api-key 映射
src/commands/auth-choice.apply.api-providers.ts修改添加 kilocode-api-key 处理逻辑
src/cli/program/register.onboard.ts修改添加 --kilocode-api-key 选项
src/commands/onboard-non-interactive/local/auth-choice.ts修改添加非交互式处理
src/commands/onboard-auth.ts修改导出新函数
src/agents/pi-embedded-runner/cache-ttl.ts修改添加 kilocode 支持
src/agents/transcript-policy.ts修改添加 kilocode Gemini 处理
arrow_back
上一页
Test
下一页
Onboarding Config Protocol
arrow_forward