mirror of
https://github.com/openclaw/openclaw.git
synced 2026-05-07 15:10:42 +00:00
88 lines
2.7 KiB
TypeScript
88 lines
2.7 KiB
TypeScript
import type { CliBackendConfig } from "../config/types.js";
|
|
import type { OpenClawConfig } from "../config/types.openclaw.js";
|
|
|
|
export type PluginTextReplacement = {
|
|
from: string | RegExp;
|
|
to: string;
|
|
};
|
|
|
|
export type PluginTextTransforms = {
|
|
/** Rewrites applied to outbound prompt text before provider/CLI transport. */
|
|
input?: PluginTextReplacement[];
|
|
/** Rewrites applied to inbound assistant text before OpenClaw consumes it. */
|
|
output?: PluginTextReplacement[];
|
|
};
|
|
|
|
export type CliBundleMcpMode =
|
|
| "claude-config-file"
|
|
| "codex-config-overrides"
|
|
| "gemini-system-settings";
|
|
|
|
/** Plugin-owned CLI backend defaults used by the text-only CLI runner. */
|
|
export type CliBackendPlugin = {
|
|
/** Provider id used in model refs, for example `claude-cli/opus`. */
|
|
id: string;
|
|
/** Default backend config before user overrides from `agents.defaults.cliBackends`. */
|
|
config: CliBackendConfig;
|
|
/**
|
|
* Optional live-smoke metadata owned by the backend plugin.
|
|
*
|
|
* Keep provider-specific test wiring here instead of scattering it across
|
|
* Docker wrappers, docs, and gateway live tests.
|
|
*/
|
|
liveTest?: {
|
|
defaultModelRef?: string;
|
|
defaultImageProbe?: boolean;
|
|
defaultMcpProbe?: boolean;
|
|
docker?: {
|
|
npmPackage?: string;
|
|
binaryName?: string;
|
|
};
|
|
};
|
|
/**
|
|
* Whether OpenClaw should inject bundle MCP config for this backend.
|
|
*
|
|
* Keep this opt-in. Only backends that explicitly consume OpenClaw's bundle
|
|
* MCP bridge should enable it.
|
|
*/
|
|
bundleMcp?: boolean;
|
|
/**
|
|
* Provider-owned bundle MCP integration strategy.
|
|
*
|
|
* Different CLIs wire MCP through different surfaces:
|
|
* - Claude: `--strict-mcp-config --mcp-config`
|
|
* - Codex: `-c mcp_servers=...`
|
|
* - Gemini: system-level `settings.json`
|
|
*/
|
|
bundleMcpMode?: CliBundleMcpMode;
|
|
/**
|
|
* Optional config normalizer applied after user overrides merge.
|
|
*
|
|
* Use this for backend-specific compatibility rewrites when old config
|
|
* shapes need to stay working.
|
|
*/
|
|
normalizeConfig?: (config: CliBackendConfig) => CliBackendConfig;
|
|
/**
|
|
* Backend-owned final system-prompt transform.
|
|
*
|
|
* Use this for tiny CLI-specific compatibility rewrites without replacing
|
|
* the generic CLI runner or prompt builder.
|
|
*/
|
|
transformSystemPrompt?: (ctx: {
|
|
config?: OpenClawConfig;
|
|
workspaceDir?: string;
|
|
provider: string;
|
|
modelId: string;
|
|
modelDisplay: string;
|
|
agentId?: string;
|
|
systemPrompt: string;
|
|
}) => string | null | undefined;
|
|
/**
|
|
* Backend-owned bidirectional text replacements.
|
|
*
|
|
* `input` applies to the system prompt and user prompt passed to the CLI.
|
|
* `output` applies to parsed/streamed assistant text from the CLI.
|
|
*/
|
|
textTransforms?: PluginTextTransforms;
|
|
};
|