From ce078367e40d04b938271afbfab341952f12936e Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Tue, 14 Jul 2026 23:35:52 -0400 Subject: [PATCH] fix(docs): preserve plugin surface identifiers --- docs/plugins/reference/admin-http-rpc.md | 2 +- docs/plugins/reference/alibaba.md | 2 +- .../reference/amazon-bedrock-mantle.md | 2 +- docs/plugins/reference/amazon-bedrock.md | 2 +- docs/plugins/reference/anthropic-vertex.md | 2 +- docs/plugins/reference/anthropic.md | 2 +- docs/plugins/reference/arcee.md | 2 +- docs/plugins/reference/azure-speech.md | 2 +- docs/plugins/reference/brave.md | 2 +- docs/plugins/reference/browser.md | 2 +- docs/plugins/reference/byteplus.md | 2 +- docs/plugins/reference/canvas.md | 2 +- docs/plugins/reference/cerebras.md | 2 +- docs/plugins/reference/chutes.md | 2 +- docs/plugins/reference/clawrouter.md | 2 +- docs/plugins/reference/clickclack.md | 2 +- .../reference/cloudflare-ai-gateway.md | 2 +- docs/plugins/reference/codex.md | 2 +- docs/plugins/reference/cohere.md | 2 +- docs/plugins/reference/comfy.md | 2 +- docs/plugins/reference/copilot-proxy.md | 2 +- docs/plugins/reference/crabbox.md | 2 +- docs/plugins/reference/deepgram.md | 2 +- docs/plugins/reference/deepinfra.md | 2 +- docs/plugins/reference/deepseek.md | 2 +- docs/plugins/reference/diffs.md | 2 +- docs/plugins/reference/discord.md | 2 +- docs/plugins/reference/document-extract.md | 2 +- docs/plugins/reference/duckduckgo.md | 2 +- docs/plugins/reference/elevenlabs.md | 2 +- docs/plugins/reference/exa.md | 2 +- docs/plugins/reference/fal.md | 2 +- docs/plugins/reference/featherless.md | 2 +- docs/plugins/reference/feishu.md | 2 +- docs/plugins/reference/file-transfer.md | 2 +- docs/plugins/reference/firecrawl.md | 2 +- docs/plugins/reference/fireworks.md | 2 +- docs/plugins/reference/github-copilot.md | 2 +- docs/plugins/reference/gmi.md | 2 +- docs/plugins/reference/google-meet.md | 2 +- docs/plugins/reference/google.md | 2 +- docs/plugins/reference/googlechat.md | 2 +- docs/plugins/reference/gradium.md | 2 +- docs/plugins/reference/groq.md | 2 +- docs/plugins/reference/huggingface.md | 2 +- docs/plugins/reference/imessage.md | 2 +- docs/plugins/reference/inworld.md | 2 +- docs/plugins/reference/irc.md | 2 +- docs/plugins/reference/kilocode.md | 2 +- docs/plugins/reference/kimi.md | 2 +- docs/plugins/reference/line.md | 2 +- docs/plugins/reference/litellm.md | 2 +- docs/plugins/reference/llama-cpp.md | 2 +- docs/plugins/reference/llm-task.md | 2 +- docs/plugins/reference/lmstudio.md | 2 +- docs/plugins/reference/lobster.md | 2 +- docs/plugins/reference/longcat.md | 2 +- docs/plugins/reference/matrix.md | 2 +- docs/plugins/reference/mattermost.md | 2 +- docs/plugins/reference/memory-core.md | 2 +- docs/plugins/reference/memory-lancedb.md | 2 +- docs/plugins/reference/memory-wiki.md | 2 +- docs/plugins/reference/meta.md | 2 +- docs/plugins/reference/microsoft-foundry.md | 2 +- docs/plugins/reference/microsoft.md | 2 +- docs/plugins/reference/migrate-claude.md | 2 +- docs/plugins/reference/migrate-hermes.md | 2 +- docs/plugins/reference/minimax.md | 2 +- docs/plugins/reference/mistral.md | 2 +- docs/plugins/reference/moonshot.md | 2 +- docs/plugins/reference/msteams.md | 2 +- docs/plugins/reference/nextcloud-talk.md | 2 +- docs/plugins/reference/nostr.md | 2 +- docs/plugins/reference/novita.md | 2 +- docs/plugins/reference/nvidia.md | 2 +- docs/plugins/reference/ollama.md | 2 +- docs/plugins/reference/onepassword.md | 2 +- docs/plugins/reference/openai.md | 2 +- docs/plugins/reference/opencode-go.md | 2 +- docs/plugins/reference/opencode.md | 2 +- docs/plugins/reference/openrouter.md | 2 +- docs/plugins/reference/perplexity.md | 2 +- docs/plugins/reference/pixverse.md | 2 +- docs/plugins/reference/qa-channel.md | 2 +- docs/plugins/reference/qa-lab.md | 2 +- docs/plugins/reference/qianfan.md | 2 +- docs/plugins/reference/qqbot.md | 2 +- docs/plugins/reference/qwen.md | 2 +- docs/plugins/reference/raft.md | 2 +- docs/plugins/reference/reef.md | 2 +- docs/plugins/reference/runway.md | 2 +- docs/plugins/reference/searxng.md | 2 +- docs/plugins/reference/senseaudio.md | 2 +- docs/plugins/reference/sglang.md | 2 +- docs/plugins/reference/signal.md | 2 +- docs/plugins/reference/slack.md | 2 +- docs/plugins/reference/sms.md | 2 +- docs/plugins/reference/stepfun.md | 2 +- docs/plugins/reference/synology-chat.md | 2 +- docs/plugins/reference/synthetic.md | 2 +- docs/plugins/reference/tavily.md | 2 +- docs/plugins/reference/telegram.md | 2 +- docs/plugins/reference/tencent.md | 2 +- docs/plugins/reference/tlon.md | 2 +- docs/plugins/reference/together.md | 2 +- docs/plugins/reference/tokenjuice.md | 2 +- docs/plugins/reference/tts-local-cli.md | 2 +- docs/plugins/reference/twitch.md | 2 +- docs/plugins/reference/venice.md | 2 +- docs/plugins/reference/vercel-ai-gateway.md | 2 +- docs/plugins/reference/vllm.md | 2 +- docs/plugins/reference/voice-call.md | 2 +- docs/plugins/reference/volcengine.md | 2 +- docs/plugins/reference/voyage.md | 2 +- docs/plugins/reference/vydra.md | 2 +- docs/plugins/reference/web-readability.md | 2 +- docs/plugins/reference/whatsapp.md | 2 +- docs/plugins/reference/workboard.md | 2 +- docs/plugins/reference/workspaces.md | 2 +- docs/plugins/reference/xai.md | 2 +- docs/plugins/reference/xiaomi.md | 2 +- docs/plugins/reference/zai.md | 2 +- docs/plugins/reference/zalo.md | 2 +- docs/plugins/reference/zalouser.md | 2 +- scripts/generate-plugin-inventory-doc.mjs | 26 ++----------------- scripts/lib/plugin-inventory-doc.d.mts | 9 +++++++ scripts/lib/plugin-inventory-doc.mjs | 26 +++++++++++++++++++ test/scripts/plugin-inventory-doc.test.ts | 24 +++++++++++++++++ 128 files changed, 185 insertions(+), 148 deletions(-) create mode 100644 scripts/lib/plugin-inventory-doc.d.mts create mode 100644 scripts/lib/plugin-inventory-doc.mjs create mode 100644 test/scripts/plugin-inventory-doc.test.ts diff --git a/docs/plugins/reference/admin-http-rpc.md b/docs/plugins/reference/admin-http-rpc.md index 3731495dda73..030c2af99e81 100644 --- a/docs/plugins/reference/admin-http-rpc.md +++ b/docs/plugins/reference/admin-http-rpc.md @@ -16,7 +16,7 @@ OpenClaw admin HTTP RPC endpoint. ## Surface -contracts: gatewayMethodDispatch +contracts: `gatewayMethodDispatch` ## Related docs diff --git a/docs/plugins/reference/alibaba.md b/docs/plugins/reference/alibaba.md index c2b485479b10..4b8824d3e0d0 100644 --- a/docs/plugins/reference/alibaba.md +++ b/docs/plugins/reference/alibaba.md @@ -16,7 +16,7 @@ Adds video generation provider support. ## Surface -contracts: videoGenerationProviders +contracts: `videoGenerationProviders` ## Related docs diff --git a/docs/plugins/reference/amazon-bedrock-mantle.md b/docs/plugins/reference/amazon-bedrock-mantle.md index ea27bcd1f8ac..0b8d25efaf95 100644 --- a/docs/plugins/reference/amazon-bedrock-mantle.md +++ b/docs/plugins/reference/amazon-bedrock-mantle.md @@ -16,7 +16,7 @@ OpenClaw Amazon Bedrock Mantle provider plugin for OpenAI-compatible model routi ## Surface -providers: amazon-bedrock-mantle +providers: `amazon-bedrock-mantle` ## Related docs diff --git a/docs/plugins/reference/amazon-bedrock.md b/docs/plugins/reference/amazon-bedrock.md index a588105b592b..8f750f015bdb 100644 --- a/docs/plugins/reference/amazon-bedrock.md +++ b/docs/plugins/reference/amazon-bedrock.md @@ -16,7 +16,7 @@ OpenClaw Amazon Bedrock provider plugin with model discovery, embeddings, and gu ## Surface -providers: amazon-bedrock; contracts: memoryEmbeddingProviders +providers: `amazon-bedrock`; contracts: `memoryEmbeddingProviders` ## Related docs diff --git a/docs/plugins/reference/anthropic-vertex.md b/docs/plugins/reference/anthropic-vertex.md index 4de323f67fe1..5f3250859924 100644 --- a/docs/plugins/reference/anthropic-vertex.md +++ b/docs/plugins/reference/anthropic-vertex.md @@ -16,7 +16,7 @@ OpenClaw Anthropic Vertex provider plugin for Claude models on Google Vertex AI. ## Surface -providers: anthropic-vertex +providers: `anthropic-vertex` diff --git a/docs/plugins/reference/anthropic.md b/docs/plugins/reference/anthropic.md index 092384d29ca4..9c8465f7c91b 100644 --- a/docs/plugins/reference/anthropic.md +++ b/docs/plugins/reference/anthropic.md @@ -16,7 +16,7 @@ Anthropic models, Claude CLI, and native Claude session catalog. ## Surface -providers: anthropic; contracts: mediaUnderstandingProviders, usageProviders +providers: `anthropic`; contracts: `mediaUnderstandingProviders`, `usageProviders` diff --git a/docs/plugins/reference/arcee.md b/docs/plugins/reference/arcee.md index 460939772110..0e55e5323b52 100644 --- a/docs/plugins/reference/arcee.md +++ b/docs/plugins/reference/arcee.md @@ -16,7 +16,7 @@ Adds Arcee model provider support to OpenClaw. ## Surface -providers: arcee +providers: `arcee` ## Related docs diff --git a/docs/plugins/reference/azure-speech.md b/docs/plugins/reference/azure-speech.md index abb122a975e1..5510266328c0 100644 --- a/docs/plugins/reference/azure-speech.md +++ b/docs/plugins/reference/azure-speech.md @@ -16,7 +16,7 @@ Azure AI Speech text-to-speech (MP3, native Ogg/Opus voice notes, PCM telephony) ## Surface -contracts: speechProviders +contracts: `speechProviders` ## Related docs diff --git a/docs/plugins/reference/brave.md b/docs/plugins/reference/brave.md index a833f9bd7925..9f72ff41484e 100644 --- a/docs/plugins/reference/brave.md +++ b/docs/plugins/reference/brave.md @@ -16,7 +16,7 @@ OpenClaw Brave Search provider plugin for web search. ## Surface -contracts: webSearchProviders +contracts: `webSearchProviders` ## Related docs diff --git a/docs/plugins/reference/browser.md b/docs/plugins/reference/browser.md index acd25ddefce4..ef93dc19e2ba 100644 --- a/docs/plugins/reference/browser.md +++ b/docs/plugins/reference/browser.md @@ -16,7 +16,7 @@ Adds agent-callable tools. ## Surface -contracts: tools; skills +contracts: `tools`; skills ## Related docs diff --git a/docs/plugins/reference/byteplus.md b/docs/plugins/reference/byteplus.md index 198a47b032fd..045fb1876c26 100644 --- a/docs/plugins/reference/byteplus.md +++ b/docs/plugins/reference/byteplus.md @@ -16,4 +16,4 @@ Adds BytePlus, BytePlus Plan model provider support to OpenClaw. ## Surface -providers: byteplus, byteplus-plan; contracts: videoGenerationProviders +providers: `byteplus`, `byteplus-plan`; contracts: `videoGenerationProviders` diff --git a/docs/plugins/reference/canvas.md b/docs/plugins/reference/canvas.md index 572221a6aeb7..27b146737e49 100644 --- a/docs/plugins/reference/canvas.md +++ b/docs/plugins/reference/canvas.md @@ -16,4 +16,4 @@ Experimental Canvas control and A2UI rendering surfaces for paired nodes. ## Surface -contracts: tools; skills +contracts: `tools`; skills diff --git a/docs/plugins/reference/cerebras.md b/docs/plugins/reference/cerebras.md index 1db2f11e9f99..b13cc9acf874 100644 --- a/docs/plugins/reference/cerebras.md +++ b/docs/plugins/reference/cerebras.md @@ -16,7 +16,7 @@ Adds Cerebras model provider support to OpenClaw. ## Surface -providers: cerebras +providers: `cerebras` ## Related docs diff --git a/docs/plugins/reference/chutes.md b/docs/plugins/reference/chutes.md index b21485433fe5..598685ba3a00 100644 --- a/docs/plugins/reference/chutes.md +++ b/docs/plugins/reference/chutes.md @@ -16,7 +16,7 @@ Adds Chutes model provider support to OpenClaw. ## Surface -providers: chutes +providers: `chutes` ## Related docs diff --git a/docs/plugins/reference/clawrouter.md b/docs/plugins/reference/clawrouter.md index ab5b05fb40a9..b2416af4fb31 100644 --- a/docs/plugins/reference/clawrouter.md +++ b/docs/plugins/reference/clawrouter.md @@ -16,7 +16,7 @@ Adds ClawRouter model provider support to OpenClaw. ## Surface -providers: clawrouter; contracts: usageProviders +providers: `clawrouter`; contracts: `usageProviders` ## Related docs diff --git a/docs/plugins/reference/clickclack.md b/docs/plugins/reference/clickclack.md index 9ef203b7534f..97e491ceda6b 100644 --- a/docs/plugins/reference/clickclack.md +++ b/docs/plugins/reference/clickclack.md @@ -16,7 +16,7 @@ Adds the Clickclack channel surface for sending and receiving OpenClaw messages. ## Surface -channels: clickclack +channels: `clickclack` ## Related docs diff --git a/docs/plugins/reference/cloudflare-ai-gateway.md b/docs/plugins/reference/cloudflare-ai-gateway.md index a0879363688d..61b460fd9e25 100644 --- a/docs/plugins/reference/cloudflare-ai-gateway.md +++ b/docs/plugins/reference/cloudflare-ai-gateway.md @@ -16,7 +16,7 @@ Adds Cloudflare AI Gateway model provider support to OpenClaw. ## Surface -providers: cloudflare-ai-gateway +providers: `cloudflare-ai-gateway` ## Related docs diff --git a/docs/plugins/reference/codex.md b/docs/plugins/reference/codex.md index 105fe9fb238b..130032b839ef 100644 --- a/docs/plugins/reference/codex.md +++ b/docs/plugins/reference/codex.md @@ -16,7 +16,7 @@ Codex app-server harness, model provider, and native session catalog. ## Surface -providers: codex; contracts: mediaUnderstandingProviders, migrationProviders, tools, webSearchProviders +providers: `codex`; contracts: `mediaUnderstandingProviders`, `migrationProviders`, `tools`, `webSearchProviders` ## Related docs diff --git a/docs/plugins/reference/cohere.md b/docs/plugins/reference/cohere.md index 6a6fdee51f82..2260d317283d 100644 --- a/docs/plugins/reference/cohere.md +++ b/docs/plugins/reference/cohere.md @@ -16,7 +16,7 @@ OpenClaw Cohere provider plugin. ## Surface -providers: cohere +providers: `cohere` ## Related docs diff --git a/docs/plugins/reference/comfy.md b/docs/plugins/reference/comfy.md index 4d0028e58865..d1675a40e98a 100644 --- a/docs/plugins/reference/comfy.md +++ b/docs/plugins/reference/comfy.md @@ -16,7 +16,7 @@ Adds ComfyUI model provider support to OpenClaw. ## Surface -providers: comfy; contracts: imageGenerationProviders, musicGenerationProviders, videoGenerationProviders +providers: `comfy`; contracts: `imageGenerationProviders`, `musicGenerationProviders`, `videoGenerationProviders` ## Related docs diff --git a/docs/plugins/reference/copilot-proxy.md b/docs/plugins/reference/copilot-proxy.md index 65b0402d7006..9a028fe82aff 100644 --- a/docs/plugins/reference/copilot-proxy.md +++ b/docs/plugins/reference/copilot-proxy.md @@ -16,4 +16,4 @@ Adds Copilot Proxy model provider support to OpenClaw. ## Surface -providers: copilot-proxy +providers: `copilot-proxy` diff --git a/docs/plugins/reference/crabbox.md b/docs/plugins/reference/crabbox.md index 25a0914968fb..1067fa8f9068 100644 --- a/docs/plugins/reference/crabbox.md +++ b/docs/plugins/reference/crabbox.md @@ -16,7 +16,7 @@ Cloud worker provider backed by the Crabbox CLI. ## Surface -contracts: workerProviders +contracts: `workerProviders` diff --git a/docs/plugins/reference/deepgram.md b/docs/plugins/reference/deepgram.md index 2dde6fde86ea..f994c0bedaaf 100644 --- a/docs/plugins/reference/deepgram.md +++ b/docs/plugins/reference/deepgram.md @@ -16,7 +16,7 @@ Adds media understanding provider support. Adds realtime transcription provider ## Surface -contracts: mediaUnderstandingProviders, realtimeTranscriptionProviders +contracts: `mediaUnderstandingProviders`, `realtimeTranscriptionProviders` ## Related docs diff --git a/docs/plugins/reference/deepinfra.md b/docs/plugins/reference/deepinfra.md index db170be8a411..d652927007c4 100644 --- a/docs/plugins/reference/deepinfra.md +++ b/docs/plugins/reference/deepinfra.md @@ -16,7 +16,7 @@ Adds DeepInfra model provider support to OpenClaw. ## Surface -providers: deepinfra; contracts: imageGenerationProviders, mediaUnderstandingProviders, memoryEmbeddingProviders, speechProviders, videoGenerationProviders +providers: `deepinfra`; contracts: `imageGenerationProviders`, `mediaUnderstandingProviders`, `memoryEmbeddingProviders`, `speechProviders`, `videoGenerationProviders` ## Related docs diff --git a/docs/plugins/reference/deepseek.md b/docs/plugins/reference/deepseek.md index 679b8a5517af..e56059cc4633 100644 --- a/docs/plugins/reference/deepseek.md +++ b/docs/plugins/reference/deepseek.md @@ -16,7 +16,7 @@ Adds DeepSeek model provider support to OpenClaw. ## Surface -providers: deepseek; contracts: usageProviders +providers: `deepseek`; contracts: `usageProviders` ## Related docs diff --git a/docs/plugins/reference/diffs.md b/docs/plugins/reference/diffs.md index c73d6aafe2b3..675ad6ed8a57 100644 --- a/docs/plugins/reference/diffs.md +++ b/docs/plugins/reference/diffs.md @@ -16,4 +16,4 @@ OpenClaw read-only diff viewer plugin and file renderer for agents. ## Surface -contracts: tools; skills +contracts: `tools`; skills diff --git a/docs/plugins/reference/discord.md b/docs/plugins/reference/discord.md index 876cc94ef55a..712aa0cd9402 100644 --- a/docs/plugins/reference/discord.md +++ b/docs/plugins/reference/discord.md @@ -16,7 +16,7 @@ OpenClaw Discord channel plugin for channels, DMs, commands, and app events. ## Surface -channels: discord; contracts: transcriptSourceProviders; skills +channels: `discord`; contracts: `transcriptSourceProviders`; skills ## Related docs diff --git a/docs/plugins/reference/document-extract.md b/docs/plugins/reference/document-extract.md index ebd4285a2c7b..eb12f0cbff1d 100644 --- a/docs/plugins/reference/document-extract.md +++ b/docs/plugins/reference/document-extract.md @@ -16,7 +16,7 @@ Extract text and fallback page images from local document attachments. ## Surface -contracts: documentExtractors +contracts: `documentExtractors` ## Related docs diff --git a/docs/plugins/reference/duckduckgo.md b/docs/plugins/reference/duckduckgo.md index 72665e8aa4cf..43769cbc1106 100644 --- a/docs/plugins/reference/duckduckgo.md +++ b/docs/plugins/reference/duckduckgo.md @@ -16,7 +16,7 @@ Adds web search provider support. ## Surface -contracts: webSearchProviders +contracts: `webSearchProviders` ## Related docs diff --git a/docs/plugins/reference/elevenlabs.md b/docs/plugins/reference/elevenlabs.md index a32df84c08ee..81c1f8b13b10 100644 --- a/docs/plugins/reference/elevenlabs.md +++ b/docs/plugins/reference/elevenlabs.md @@ -16,7 +16,7 @@ Adds media understanding provider support. Adds realtime transcription provider ## Surface -contracts: mediaUnderstandingProviders, realtimeTranscriptionProviders, speechProviders +contracts: `mediaUnderstandingProviders`, `realtimeTranscriptionProviders`, `speechProviders` ## Related docs diff --git a/docs/plugins/reference/exa.md b/docs/plugins/reference/exa.md index 564c57c3e6d0..074061838c81 100644 --- a/docs/plugins/reference/exa.md +++ b/docs/plugins/reference/exa.md @@ -16,7 +16,7 @@ Adds web search provider support. ## Surface -contracts: webSearchProviders +contracts: `webSearchProviders` ## Related docs diff --git a/docs/plugins/reference/fal.md b/docs/plugins/reference/fal.md index 35be46a6e4e6..8b0a2064570e 100644 --- a/docs/plugins/reference/fal.md +++ b/docs/plugins/reference/fal.md @@ -16,7 +16,7 @@ Adds fal model provider support to OpenClaw. ## Surface -providers: fal; contracts: imageGenerationProviders, musicGenerationProviders, videoGenerationProviders +providers: `fal`; contracts: `imageGenerationProviders`, `musicGenerationProviders`, `videoGenerationProviders` ## Related docs diff --git a/docs/plugins/reference/featherless.md b/docs/plugins/reference/featherless.md index b7a829ccf26c..cae4b172f6d3 100644 --- a/docs/plugins/reference/featherless.md +++ b/docs/plugins/reference/featherless.md @@ -16,7 +16,7 @@ OpenClaw Featherless AI provider plugin. ## Surface -providers: featherless +providers: `featherless` ## Related docs diff --git a/docs/plugins/reference/feishu.md b/docs/plugins/reference/feishu.md index ccfb2c6ec14b..634badd8e300 100644 --- a/docs/plugins/reference/feishu.md +++ b/docs/plugins/reference/feishu.md @@ -16,7 +16,7 @@ OpenClaw Feishu/Lark channel plugin for chats and workplace tools (community mai ## Surface -channels: feishu; contracts: tools; skills +channels: `feishu`; contracts: `tools`; skills ## Related docs diff --git a/docs/plugins/reference/file-transfer.md b/docs/plugins/reference/file-transfer.md index 7e625f422f0d..d16e873fd1ef 100644 --- a/docs/plugins/reference/file-transfer.md +++ b/docs/plugins/reference/file-transfer.md @@ -16,4 +16,4 @@ Fetch, list, and write files on paired nodes via dedicated node commands. Bypass ## Surface -contracts: tools +contracts: `tools` diff --git a/docs/plugins/reference/firecrawl.md b/docs/plugins/reference/firecrawl.md index 9d289e33c1a7..120a77ffc0ea 100644 --- a/docs/plugins/reference/firecrawl.md +++ b/docs/plugins/reference/firecrawl.md @@ -16,7 +16,7 @@ Adds agent-callable tools. Adds web fetch provider support. Adds web search prov ## Surface -contracts: tools, webFetchProviders, webSearchProviders +contracts: `tools`, `webFetchProviders`, `webSearchProviders` ## Related docs diff --git a/docs/plugins/reference/fireworks.md b/docs/plugins/reference/fireworks.md index a7566c710130..1b4b1ae6de9b 100644 --- a/docs/plugins/reference/fireworks.md +++ b/docs/plugins/reference/fireworks.md @@ -16,7 +16,7 @@ Adds Fireworks model provider support to OpenClaw. ## Surface -providers: fireworks +providers: `fireworks` ## Related docs diff --git a/docs/plugins/reference/github-copilot.md b/docs/plugins/reference/github-copilot.md index 569c73a73ac6..48bcc9ffc0d5 100644 --- a/docs/plugins/reference/github-copilot.md +++ b/docs/plugins/reference/github-copilot.md @@ -16,7 +16,7 @@ Adds GitHub Copilot model provider support to OpenClaw. ## Surface -providers: github-copilot; contracts: memoryEmbeddingProviders, usageProviders +providers: `github-copilot`; contracts: `memoryEmbeddingProviders`, `usageProviders` ## Related docs diff --git a/docs/plugins/reference/gmi.md b/docs/plugins/reference/gmi.md index dffdfe4a2aca..5716dcde00ca 100644 --- a/docs/plugins/reference/gmi.md +++ b/docs/plugins/reference/gmi.md @@ -16,7 +16,7 @@ OpenClaw GMI Cloud provider plugin. ## Surface -providers: gmi, gmi-cloud, gmicloud +providers: `gmi`, `gmi-cloud`, `gmicloud` ## Related docs diff --git a/docs/plugins/reference/google-meet.md b/docs/plugins/reference/google-meet.md index 3ea10286c9e1..dd0d6585ebf5 100644 --- a/docs/plugins/reference/google-meet.md +++ b/docs/plugins/reference/google-meet.md @@ -16,7 +16,7 @@ OpenClaw Google Meet participant plugin for joining calls through Chrome or Twil ## Surface -contracts: tools +contracts: `tools` ## Related docs diff --git a/docs/plugins/reference/google.md b/docs/plugins/reference/google.md index d565a7df0573..c7917953f15c 100644 --- a/docs/plugins/reference/google.md +++ b/docs/plugins/reference/google.md @@ -16,7 +16,7 @@ Adds Google, Google Gemini CLI, Google Vertex model provider support to OpenClaw ## Surface -providers: google, google-gemini-cli, google-vertex; contracts: imageGenerationProviders, mediaUnderstandingProviders, memoryEmbeddingProviders, musicGenerationProviders, realtimeVoiceProviders, speechProviders, usageProviders, videoGenerationProviders, webSearchProviders +providers: `google`, `google-gemini-cli`, `google-vertex`; contracts: `imageGenerationProviders`, `mediaUnderstandingProviders`, `memoryEmbeddingProviders`, `musicGenerationProviders`, `realtimeVoiceProviders`, `speechProviders`, `usageProviders`, `videoGenerationProviders`, `webSearchProviders` ## Related docs diff --git a/docs/plugins/reference/googlechat.md b/docs/plugins/reference/googlechat.md index e23a5ae7980b..0cd03e56e3ac 100644 --- a/docs/plugins/reference/googlechat.md +++ b/docs/plugins/reference/googlechat.md @@ -16,7 +16,7 @@ OpenClaw Google Chat channel plugin for spaces and direct messages. ## Surface -channels: googlechat +channels: `googlechat` ## Related docs diff --git a/docs/plugins/reference/gradium.md b/docs/plugins/reference/gradium.md index be9795726d48..1d6cc99fc512 100644 --- a/docs/plugins/reference/gradium.md +++ b/docs/plugins/reference/gradium.md @@ -16,7 +16,7 @@ Adds text-to-speech provider support. ## Surface -contracts: speechProviders +contracts: `speechProviders` ## Related docs diff --git a/docs/plugins/reference/groq.md b/docs/plugins/reference/groq.md index fbfa8c84d633..e7aacc9464ee 100644 --- a/docs/plugins/reference/groq.md +++ b/docs/plugins/reference/groq.md @@ -16,7 +16,7 @@ Adds Groq model provider support to OpenClaw. ## Surface -providers: groq; contracts: mediaUnderstandingProviders +providers: `groq`; contracts: `mediaUnderstandingProviders` ## Related docs diff --git a/docs/plugins/reference/huggingface.md b/docs/plugins/reference/huggingface.md index 3e4dee503b15..2657e4b2c5d2 100644 --- a/docs/plugins/reference/huggingface.md +++ b/docs/plugins/reference/huggingface.md @@ -16,7 +16,7 @@ Adds Hugging Face model provider support to OpenClaw. ## Surface -providers: huggingface +providers: `huggingface` ## Related docs diff --git a/docs/plugins/reference/imessage.md b/docs/plugins/reference/imessage.md index b67e15f8fd23..8c6b47e0356d 100644 --- a/docs/plugins/reference/imessage.md +++ b/docs/plugins/reference/imessage.md @@ -16,7 +16,7 @@ Adds the iMessage channel surface for sending and receiving OpenClaw messages. ## Surface -channels: imessage; skills +channels: `imessage`; skills ## Related docs diff --git a/docs/plugins/reference/inworld.md b/docs/plugins/reference/inworld.md index 13a32d304b39..e172ff371733 100644 --- a/docs/plugins/reference/inworld.md +++ b/docs/plugins/reference/inworld.md @@ -16,7 +16,7 @@ Inworld streaming text-to-speech (MP3, OGG_OPUS, PCM telephony). ## Surface -contracts: speechProviders +contracts: `speechProviders` ## Related docs diff --git a/docs/plugins/reference/irc.md b/docs/plugins/reference/irc.md index b3bea9c8cd7a..d8470e8986cd 100644 --- a/docs/plugins/reference/irc.md +++ b/docs/plugins/reference/irc.md @@ -16,7 +16,7 @@ Adds the IRC channel surface for sending and receiving OpenClaw messages. ## Surface -channels: irc +channels: `irc` ## Related docs diff --git a/docs/plugins/reference/kilocode.md b/docs/plugins/reference/kilocode.md index f88c36fbca29..8d74d4636a6d 100644 --- a/docs/plugins/reference/kilocode.md +++ b/docs/plugins/reference/kilocode.md @@ -16,7 +16,7 @@ Adds Kilocode model provider support to OpenClaw. ## Surface -providers: kilocode +providers: `kilocode` ## Related docs diff --git a/docs/plugins/reference/kimi.md b/docs/plugins/reference/kimi.md index 63d324da4ee8..372fb78e9cf4 100644 --- a/docs/plugins/reference/kimi.md +++ b/docs/plugins/reference/kimi.md @@ -16,7 +16,7 @@ Adds Kimi, Kimi Coding model provider support to OpenClaw. ## Surface -providers: kimi, kimi-coding +providers: `kimi`, `kimi-coding` ## Related docs diff --git a/docs/plugins/reference/line.md b/docs/plugins/reference/line.md index 9a191a83c2c7..aca4dd810e9c 100644 --- a/docs/plugins/reference/line.md +++ b/docs/plugins/reference/line.md @@ -16,7 +16,7 @@ OpenClaw LINE channel plugin for LINE Bot API chats. ## Surface -channels: line +channels: `line` ## Related docs diff --git a/docs/plugins/reference/litellm.md b/docs/plugins/reference/litellm.md index d93782a077c3..b85f116cb7ff 100644 --- a/docs/plugins/reference/litellm.md +++ b/docs/plugins/reference/litellm.md @@ -16,7 +16,7 @@ Adds LiteLLM model provider support to OpenClaw. ## Surface -providers: litellm; contracts: imageGenerationProviders +providers: `litellm`; contracts: `imageGenerationProviders` ## Related docs diff --git a/docs/plugins/reference/llama-cpp.md b/docs/plugins/reference/llama-cpp.md index 44323793198e..55dd69ff0bd0 100644 --- a/docs/plugins/reference/llama-cpp.md +++ b/docs/plugins/reference/llama-cpp.md @@ -16,7 +16,7 @@ Local GGUF embeddings through node-llama-cpp. ## Surface -contracts: embeddingProviders +contracts: `embeddingProviders` ## Related docs diff --git a/docs/plugins/reference/llm-task.md b/docs/plugins/reference/llm-task.md index 755b6ef515bc..75186b3dde2a 100644 --- a/docs/plugins/reference/llm-task.md +++ b/docs/plugins/reference/llm-task.md @@ -16,4 +16,4 @@ Generic JSON-only LLM tool for structured tasks callable from workflows. ## Surface -contracts: tools +contracts: `tools` diff --git a/docs/plugins/reference/lmstudio.md b/docs/plugins/reference/lmstudio.md index 8a8fc854b9dd..eb531ae99bf1 100644 --- a/docs/plugins/reference/lmstudio.md +++ b/docs/plugins/reference/lmstudio.md @@ -16,7 +16,7 @@ Adds LM Studio model provider support to OpenClaw. ## Surface -providers: lmstudio; contracts: memoryEmbeddingProviders +providers: `lmstudio`; contracts: `memoryEmbeddingProviders` ## Related docs diff --git a/docs/plugins/reference/lobster.md b/docs/plugins/reference/lobster.md index f877eef4d5ce..a9702c563270 100644 --- a/docs/plugins/reference/lobster.md +++ b/docs/plugins/reference/lobster.md @@ -16,4 +16,4 @@ Lobster workflow tool plugin for typed pipelines and resumable approvals. ## Surface -contracts: tools +contracts: `tools` diff --git a/docs/plugins/reference/longcat.md b/docs/plugins/reference/longcat.md index fe8a0c06fd3e..a18c4ee3d614 100644 --- a/docs/plugins/reference/longcat.md +++ b/docs/plugins/reference/longcat.md @@ -16,7 +16,7 @@ OpenClaw LongCat provider plugin. ## Surface -providers: longcat +providers: `longcat` ## Related docs diff --git a/docs/plugins/reference/matrix.md b/docs/plugins/reference/matrix.md index a334e20cac51..4da82e54c3e2 100644 --- a/docs/plugins/reference/matrix.md +++ b/docs/plugins/reference/matrix.md @@ -16,7 +16,7 @@ OpenClaw Matrix channel plugin for rooms and direct messages. ## Surface -channels: matrix +channels: `matrix` ## Related docs diff --git a/docs/plugins/reference/mattermost.md b/docs/plugins/reference/mattermost.md index da271bdce30f..abcb29effd11 100644 --- a/docs/plugins/reference/mattermost.md +++ b/docs/plugins/reference/mattermost.md @@ -16,7 +16,7 @@ Adds the Mattermost channel surface for sending and receiving OpenClaw messages. ## Surface -channels: mattermost +channels: `mattermost` ## Related docs diff --git a/docs/plugins/reference/memory-core.md b/docs/plugins/reference/memory-core.md index 223f2a36d071..c5217faeeac3 100644 --- a/docs/plugins/reference/memory-core.md +++ b/docs/plugins/reference/memory-core.md @@ -16,4 +16,4 @@ Adds agent-callable tools. ## Surface -contracts: tools +contracts: `tools` diff --git a/docs/plugins/reference/memory-lancedb.md b/docs/plugins/reference/memory-lancedb.md index 5bc54a073bb6..1c9baee61118 100644 --- a/docs/plugins/reference/memory-lancedb.md +++ b/docs/plugins/reference/memory-lancedb.md @@ -16,7 +16,7 @@ OpenClaw LanceDB-backed long-term memory plugin with auto-recall, auto-capture, ## Surface -contracts: tools +contracts: `tools` ## Related docs diff --git a/docs/plugins/reference/memory-wiki.md b/docs/plugins/reference/memory-wiki.md index 82c8739302a6..b4c4ecd83636 100644 --- a/docs/plugins/reference/memory-wiki.md +++ b/docs/plugins/reference/memory-wiki.md @@ -16,7 +16,7 @@ Persistent wiki compiler and Obsidian-friendly knowledge vault for OpenClaw. ## Surface -contracts: tools; skills +contracts: `tools`; skills ## Related docs diff --git a/docs/plugins/reference/meta.md b/docs/plugins/reference/meta.md index 139edb031413..8a3388e1f4a0 100644 --- a/docs/plugins/reference/meta.md +++ b/docs/plugins/reference/meta.md @@ -16,7 +16,7 @@ Adds Meta model provider support to OpenClaw. ## Surface -providers: meta +providers: `meta` ## Related docs diff --git a/docs/plugins/reference/microsoft-foundry.md b/docs/plugins/reference/microsoft-foundry.md index c076f88f678d..c160f4eed0c8 100644 --- a/docs/plugins/reference/microsoft-foundry.md +++ b/docs/plugins/reference/microsoft-foundry.md @@ -16,7 +16,7 @@ Adds Microsoft Foundry model provider support to OpenClaw. ## Surface -providers: microsoft-foundry; contracts: imageGenerationProviders +providers: `microsoft-foundry`; contracts: `imageGenerationProviders` diff --git a/docs/plugins/reference/microsoft.md b/docs/plugins/reference/microsoft.md index d30d365f7297..b7fd64316522 100644 --- a/docs/plugins/reference/microsoft.md +++ b/docs/plugins/reference/microsoft.md @@ -16,4 +16,4 @@ Adds text-to-speech provider support. ## Surface -contracts: speechProviders +contracts: `speechProviders` diff --git a/docs/plugins/reference/migrate-claude.md b/docs/plugins/reference/migrate-claude.md index 638ebe3a6f50..527b254237ba 100644 --- a/docs/plugins/reference/migrate-claude.md +++ b/docs/plugins/reference/migrate-claude.md @@ -16,4 +16,4 @@ Imports Claude Code and Claude Desktop instructions, MCP servers, skills, and sa ## Surface -contracts: migrationProviders +contracts: `migrationProviders` diff --git a/docs/plugins/reference/migrate-hermes.md b/docs/plugins/reference/migrate-hermes.md index 1b2d135989eb..990535426663 100644 --- a/docs/plugins/reference/migrate-hermes.md +++ b/docs/plugins/reference/migrate-hermes.md @@ -16,4 +16,4 @@ Imports Hermes configuration, memories, skills, and supported credentials into O ## Surface -contracts: migrationProviders +contracts: `migrationProviders` diff --git a/docs/plugins/reference/minimax.md b/docs/plugins/reference/minimax.md index 35d7a8ff046f..fe5879203638 100644 --- a/docs/plugins/reference/minimax.md +++ b/docs/plugins/reference/minimax.md @@ -16,7 +16,7 @@ Adds MiniMax, MiniMax Portal model provider support to OpenClaw. ## Surface -providers: minimax, minimax-portal; contracts: imageGenerationProviders, mediaUnderstandingProviders, musicGenerationProviders, speechProviders, usageProviders, videoGenerationProviders, webSearchProviders +providers: `minimax`, `minimax-portal`; contracts: `imageGenerationProviders`, `mediaUnderstandingProviders`, `musicGenerationProviders`, `speechProviders`, `usageProviders`, `videoGenerationProviders`, `webSearchProviders` ## Related docs diff --git a/docs/plugins/reference/mistral.md b/docs/plugins/reference/mistral.md index 4e67ab0eaa2a..95939e1af647 100644 --- a/docs/plugins/reference/mistral.md +++ b/docs/plugins/reference/mistral.md @@ -16,7 +16,7 @@ Adds Mistral model provider support to OpenClaw. ## Surface -providers: mistral; contracts: mediaUnderstandingProviders, memoryEmbeddingProviders, realtimeTranscriptionProviders +providers: `mistral`; contracts: `mediaUnderstandingProviders`, `memoryEmbeddingProviders`, `realtimeTranscriptionProviders` ## Related docs diff --git a/docs/plugins/reference/moonshot.md b/docs/plugins/reference/moonshot.md index 37670f81e311..2bcf41050e84 100644 --- a/docs/plugins/reference/moonshot.md +++ b/docs/plugins/reference/moonshot.md @@ -16,7 +16,7 @@ Adds Moonshot model provider support to OpenClaw. ## Surface -providers: moonshot; contracts: mediaUnderstandingProviders, webSearchProviders +providers: `moonshot`; contracts: `mediaUnderstandingProviders`, `webSearchProviders` ## Related docs diff --git a/docs/plugins/reference/msteams.md b/docs/plugins/reference/msteams.md index bd10f925b29f..ea8a37c2623b 100644 --- a/docs/plugins/reference/msteams.md +++ b/docs/plugins/reference/msteams.md @@ -16,7 +16,7 @@ OpenClaw Microsoft Teams channel plugin for bot conversations. ## Surface -channels: msteams +channels: `msteams` ## Related docs diff --git a/docs/plugins/reference/nextcloud-talk.md b/docs/plugins/reference/nextcloud-talk.md index abccb0268ae6..c0ad4663d3c9 100644 --- a/docs/plugins/reference/nextcloud-talk.md +++ b/docs/plugins/reference/nextcloud-talk.md @@ -16,7 +16,7 @@ OpenClaw Nextcloud Talk channel plugin for conversations. ## Surface -channels: nextcloud-talk +channels: `nextcloud-talk` ## Related docs diff --git a/docs/plugins/reference/nostr.md b/docs/plugins/reference/nostr.md index aaa3ac2d7318..aac07e1bbeed 100644 --- a/docs/plugins/reference/nostr.md +++ b/docs/plugins/reference/nostr.md @@ -16,7 +16,7 @@ OpenClaw Nostr channel plugin for NIP-04 encrypted direct messages. ## Surface -channels: nostr +channels: `nostr` ## Related docs diff --git a/docs/plugins/reference/novita.md b/docs/plugins/reference/novita.md index 911a20b9a7ad..2e9485426a10 100644 --- a/docs/plugins/reference/novita.md +++ b/docs/plugins/reference/novita.md @@ -16,7 +16,7 @@ Adds Novita, Novita AI, Novitaai model provider support to OpenClaw. ## Surface -providers: novita, novita-ai, novitaai +providers: `novita`, `novita-ai`, `novitaai` ## Related docs diff --git a/docs/plugins/reference/nvidia.md b/docs/plugins/reference/nvidia.md index 379b2521cdb4..577e5ee9e2c4 100644 --- a/docs/plugins/reference/nvidia.md +++ b/docs/plugins/reference/nvidia.md @@ -16,7 +16,7 @@ Adds NVIDIA model provider support to OpenClaw. ## Surface -providers: nvidia +providers: `nvidia` ## Related docs diff --git a/docs/plugins/reference/ollama.md b/docs/plugins/reference/ollama.md index d9a145fcdf36..1b85dcf62ff7 100644 --- a/docs/plugins/reference/ollama.md +++ b/docs/plugins/reference/ollama.md @@ -16,7 +16,7 @@ Adds Ollama, Ollama Cloud model provider support to OpenClaw. ## Surface -providers: ollama, ollama-cloud; contracts: memoryEmbeddingProviders, tools, webSearchProviders +providers: `ollama`, `ollama-cloud`; contracts: `memoryEmbeddingProviders`, `tools`, `webSearchProviders` ## Related docs diff --git a/docs/plugins/reference/onepassword.md b/docs/plugins/reference/onepassword.md index b9b7c11c6bf0..6d4aa93c16d1 100644 --- a/docs/plugins/reference/onepassword.md +++ b/docs/plugins/reference/onepassword.md @@ -16,7 +16,7 @@ Curated 1Password secrets broker with approval policy and SQLite audit history. ## Surface -contracts: tools +contracts: `tools` ## Related docs diff --git a/docs/plugins/reference/openai.md b/docs/plugins/reference/openai.md index b852259f3a72..895cba4a844b 100644 --- a/docs/plugins/reference/openai.md +++ b/docs/plugins/reference/openai.md @@ -16,7 +16,7 @@ Adds OpenAI model provider support to OpenClaw. ## Surface -providers: openai; contracts: imageGenerationProviders, mediaUnderstandingProviders, memoryEmbeddingProviders, realtimeTranscriptionProviders, realtimeVoiceProviders, speechProviders, usageProviders, videoGenerationProviders +providers: `openai`; contracts: `imageGenerationProviders`, `mediaUnderstandingProviders`, `memoryEmbeddingProviders`, `realtimeTranscriptionProviders`, `realtimeVoiceProviders`, `speechProviders`, `usageProviders`, `videoGenerationProviders` ## Related docs diff --git a/docs/plugins/reference/opencode-go.md b/docs/plugins/reference/opencode-go.md index af4f2dc3ab61..37a5c4453171 100644 --- a/docs/plugins/reference/opencode-go.md +++ b/docs/plugins/reference/opencode-go.md @@ -16,7 +16,7 @@ Adds OpenCode Go model provider support to OpenClaw. ## Surface -providers: opencode-go; contracts: mediaUnderstandingProviders +providers: `opencode-go`; contracts: `mediaUnderstandingProviders` ## Related docs diff --git a/docs/plugins/reference/opencode.md b/docs/plugins/reference/opencode.md index 8689369d066a..331ab7290407 100644 --- a/docs/plugins/reference/opencode.md +++ b/docs/plugins/reference/opencode.md @@ -16,7 +16,7 @@ Adds OpenCode model provider support to OpenClaw. ## Surface -providers: opencode; contracts: mediaUnderstandingProviders +providers: `opencode`; contracts: `mediaUnderstandingProviders` diff --git a/docs/plugins/reference/openrouter.md b/docs/plugins/reference/openrouter.md index 673820316875..2528b2d167cc 100644 --- a/docs/plugins/reference/openrouter.md +++ b/docs/plugins/reference/openrouter.md @@ -16,7 +16,7 @@ Adds OpenRouter model provider support to OpenClaw. ## Surface -providers: openrouter; contracts: imageGenerationProviders, mediaUnderstandingProviders, musicGenerationProviders, speechProviders, usageProviders, videoGenerationProviders +providers: `openrouter`; contracts: `imageGenerationProviders`, `mediaUnderstandingProviders`, `musicGenerationProviders`, `speechProviders`, `usageProviders`, `videoGenerationProviders` ## Related docs diff --git a/docs/plugins/reference/perplexity.md b/docs/plugins/reference/perplexity.md index 74fb899ea4a3..dea5fc69f155 100644 --- a/docs/plugins/reference/perplexity.md +++ b/docs/plugins/reference/perplexity.md @@ -16,7 +16,7 @@ Adds web search provider support. ## Surface -contracts: webSearchProviders +contracts: `webSearchProviders` ## Related docs diff --git a/docs/plugins/reference/pixverse.md b/docs/plugins/reference/pixverse.md index cd94ee29e05b..6276f124707f 100644 --- a/docs/plugins/reference/pixverse.md +++ b/docs/plugins/reference/pixverse.md @@ -16,7 +16,7 @@ OpenClaw PixVerse video generation provider plugin. ## Surface -contracts: videoGenerationProviders +contracts: `videoGenerationProviders` ## Related docs diff --git a/docs/plugins/reference/qa-channel.md b/docs/plugins/reference/qa-channel.md index 8d9de64e3d56..f2673684e97c 100644 --- a/docs/plugins/reference/qa-channel.md +++ b/docs/plugins/reference/qa-channel.md @@ -16,7 +16,7 @@ Adds the QA Channel surface for sending and receiving OpenClaw messages. ## Surface -channels: qa-channel +channels: `qa-channel` ## Related docs diff --git a/docs/plugins/reference/qa-lab.md b/docs/plugins/reference/qa-lab.md index c61f8eeaa7f4..996e1121730b 100644 --- a/docs/plugins/reference/qa-lab.md +++ b/docs/plugins/reference/qa-lab.md @@ -16,4 +16,4 @@ OpenClaw QA lab plugin with private debugger UI and scenario runner. ## Surface -contracts: tools, webSearchProviders, workerProviders +contracts: `tools`, `webSearchProviders`, `workerProviders` diff --git a/docs/plugins/reference/qianfan.md b/docs/plugins/reference/qianfan.md index 6036c48240dd..67e1f40caecd 100644 --- a/docs/plugins/reference/qianfan.md +++ b/docs/plugins/reference/qianfan.md @@ -16,7 +16,7 @@ Adds Qianfan model provider support to OpenClaw. ## Surface -providers: qianfan +providers: `qianfan` ## Related docs diff --git a/docs/plugins/reference/qqbot.md b/docs/plugins/reference/qqbot.md index d7fa395c1bce..82468f74fb94 100644 --- a/docs/plugins/reference/qqbot.md +++ b/docs/plugins/reference/qqbot.md @@ -16,7 +16,7 @@ OpenClaw QQ Bot channel plugin for group and direct-message workflows. ## Surface -channels: qqbot; contracts: tools; skills +channels: `qqbot`; contracts: `tools`; skills ## Related docs diff --git a/docs/plugins/reference/qwen.md b/docs/plugins/reference/qwen.md index acd72880c02b..fd06167b3919 100644 --- a/docs/plugins/reference/qwen.md +++ b/docs/plugins/reference/qwen.md @@ -16,7 +16,7 @@ Adds Qwen, Qwen Cloud, Model Studio, DashScope, Qwen Oauth, Qwen Portal, Qwen CL ## Surface -providers: qwen, qwencloud, modelstudio, dashscope, qwen-oauth, qwen-portal, qwen-cli, qwen-token-plan, bailian-token-plan; contracts: mediaUnderstandingProviders, videoGenerationProviders +providers: `qwen`, `qwencloud`, `modelstudio`, `dashscope`, `qwen-oauth`, `qwen-portal`, `qwen-cli`, `qwen-token-plan`, `bailian-token-plan`; contracts: `mediaUnderstandingProviders`, `videoGenerationProviders` ## Related docs diff --git a/docs/plugins/reference/raft.md b/docs/plugins/reference/raft.md index 201a2d1e0863..6ef43e275e2e 100644 --- a/docs/plugins/reference/raft.md +++ b/docs/plugins/reference/raft.md @@ -16,7 +16,7 @@ OpenClaw Raft channel plugin for secure CLI wake bridges. ## Surface -channels: raft +channels: `raft` ## Related docs diff --git a/docs/plugins/reference/reef.md b/docs/plugins/reference/reef.md index 65485f2895f6..447c1aba74c5 100644 --- a/docs/plugins/reference/reef.md +++ b/docs/plugins/reference/reef.md @@ -16,7 +16,7 @@ Guarded end-to-end encrypted claw channel. ## Surface -channels: reef +channels: `reef` ## Related docs diff --git a/docs/plugins/reference/runway.md b/docs/plugins/reference/runway.md index 607ccb295ecc..9c19a43a04c5 100644 --- a/docs/plugins/reference/runway.md +++ b/docs/plugins/reference/runway.md @@ -16,7 +16,7 @@ Adds video generation provider support. ## Surface -contracts: videoGenerationProviders +contracts: `videoGenerationProviders` ## Related docs diff --git a/docs/plugins/reference/searxng.md b/docs/plugins/reference/searxng.md index 76a09be43833..da29b6b52ccc 100644 --- a/docs/plugins/reference/searxng.md +++ b/docs/plugins/reference/searxng.md @@ -16,4 +16,4 @@ Adds web search provider support. ## Surface -contracts: webSearchProviders +contracts: `webSearchProviders` diff --git a/docs/plugins/reference/senseaudio.md b/docs/plugins/reference/senseaudio.md index c93d6c485a38..f76d55e3ce3c 100644 --- a/docs/plugins/reference/senseaudio.md +++ b/docs/plugins/reference/senseaudio.md @@ -16,7 +16,7 @@ Adds media understanding provider support. ## Surface -contracts: mediaUnderstandingProviders +contracts: `mediaUnderstandingProviders` ## Related docs diff --git a/docs/plugins/reference/sglang.md b/docs/plugins/reference/sglang.md index ee5cab0e0c5b..7645e4da0bfe 100644 --- a/docs/plugins/reference/sglang.md +++ b/docs/plugins/reference/sglang.md @@ -16,7 +16,7 @@ Adds SGLang model provider support to OpenClaw. ## Surface -providers: sglang +providers: `sglang` ## Related docs diff --git a/docs/plugins/reference/signal.md b/docs/plugins/reference/signal.md index b628b60626ed..a2fc9264a994 100644 --- a/docs/plugins/reference/signal.md +++ b/docs/plugins/reference/signal.md @@ -16,7 +16,7 @@ Adds the Signal channel surface for sending and receiving OpenClaw messages. ## Surface -channels: signal +channels: `signal` ## Related docs diff --git a/docs/plugins/reference/slack.md b/docs/plugins/reference/slack.md index 1c8b2686ef5e..2d1bb3dcc7fc 100644 --- a/docs/plugins/reference/slack.md +++ b/docs/plugins/reference/slack.md @@ -16,7 +16,7 @@ OpenClaw Slack channel plugin for channels, DMs, commands, and app events. ## Surface -channels: slack; skills +channels: `slack`; skills ## Related docs diff --git a/docs/plugins/reference/sms.md b/docs/plugins/reference/sms.md index 4e6af3c6ea56..f10e40426af5 100644 --- a/docs/plugins/reference/sms.md +++ b/docs/plugins/reference/sms.md @@ -16,7 +16,7 @@ Twilio SMS channel plugin for OpenClaw text messages. ## Surface -channels: sms +channels: `sms` ## Related docs diff --git a/docs/plugins/reference/stepfun.md b/docs/plugins/reference/stepfun.md index 661e8500ee4f..8fc25ddf1ccb 100644 --- a/docs/plugins/reference/stepfun.md +++ b/docs/plugins/reference/stepfun.md @@ -16,7 +16,7 @@ Adds StepFun, StepFun Plan model provider support to OpenClaw. ## Surface -providers: stepfun, stepfun-plan +providers: `stepfun`, `stepfun-plan` ## Related docs diff --git a/docs/plugins/reference/synology-chat.md b/docs/plugins/reference/synology-chat.md index 5543e655590c..ef4dc8384fd2 100644 --- a/docs/plugins/reference/synology-chat.md +++ b/docs/plugins/reference/synology-chat.md @@ -16,7 +16,7 @@ Synology Chat channel plugin for OpenClaw channels and direct messages. ## Surface -channels: synology-chat +channels: `synology-chat` ## Related docs diff --git a/docs/plugins/reference/synthetic.md b/docs/plugins/reference/synthetic.md index 96e14d67a9e8..8eacd887529b 100644 --- a/docs/plugins/reference/synthetic.md +++ b/docs/plugins/reference/synthetic.md @@ -16,7 +16,7 @@ Adds Synthetic model provider support to OpenClaw. ## Surface -providers: synthetic +providers: `synthetic` ## Related docs diff --git a/docs/plugins/reference/tavily.md b/docs/plugins/reference/tavily.md index 79fd4b7ccd66..48519fde63df 100644 --- a/docs/plugins/reference/tavily.md +++ b/docs/plugins/reference/tavily.md @@ -16,7 +16,7 @@ Adds agent-callable tools. Adds web search provider support. ## Surface -contracts: tools, webSearchProviders; skills +contracts: `tools`, `webSearchProviders`; skills ## Related docs diff --git a/docs/plugins/reference/telegram.md b/docs/plugins/reference/telegram.md index 01607f90c30b..959218b6cbeb 100644 --- a/docs/plugins/reference/telegram.md +++ b/docs/plugins/reference/telegram.md @@ -16,7 +16,7 @@ Adds the Telegram channel surface for sending and receiving OpenClaw messages. ## Surface -channels: telegram +channels: `telegram` ## Related docs diff --git a/docs/plugins/reference/tencent.md b/docs/plugins/reference/tencent.md index 51d5c16873bf..a746297d9951 100644 --- a/docs/plugins/reference/tencent.md +++ b/docs/plugins/reference/tencent.md @@ -16,7 +16,7 @@ Adds Tencent TokenHub, Tencent Tokenplan model provider support to OpenClaw. ## Surface -providers: tencent-tokenhub, tencent-tokenplan +providers: `tencent-tokenhub`, `tencent-tokenplan` ## Related docs diff --git a/docs/plugins/reference/tlon.md b/docs/plugins/reference/tlon.md index 59fb40376779..e94ff001577f 100644 --- a/docs/plugins/reference/tlon.md +++ b/docs/plugins/reference/tlon.md @@ -16,7 +16,7 @@ OpenClaw Tlon/Urbit channel plugin for chat workflows. ## Surface -channels: tlon; skills +channels: `tlon`; skills ## Related docs diff --git a/docs/plugins/reference/together.md b/docs/plugins/reference/together.md index 73269bfc7075..efc60a230895 100644 --- a/docs/plugins/reference/together.md +++ b/docs/plugins/reference/together.md @@ -16,7 +16,7 @@ Adds Together model provider support to OpenClaw. ## Surface -providers: together; contracts: videoGenerationProviders +providers: `together`; contracts: `videoGenerationProviders` ## Related docs diff --git a/docs/plugins/reference/tokenjuice.md b/docs/plugins/reference/tokenjuice.md index 04f4008bd361..5a258a6eafe8 100644 --- a/docs/plugins/reference/tokenjuice.md +++ b/docs/plugins/reference/tokenjuice.md @@ -16,7 +16,7 @@ Compacts exec and bash tool results with tokenjuice reducers. ## Surface -contracts: agentToolResultMiddleware +contracts: `agentToolResultMiddleware` ## Related docs diff --git a/docs/plugins/reference/tts-local-cli.md b/docs/plugins/reference/tts-local-cli.md index 7190d804f051..dbaa3ec2f160 100644 --- a/docs/plugins/reference/tts-local-cli.md +++ b/docs/plugins/reference/tts-local-cli.md @@ -16,4 +16,4 @@ Adds text-to-speech provider support. ## Surface -contracts: speechProviders +contracts: `speechProviders` diff --git a/docs/plugins/reference/twitch.md b/docs/plugins/reference/twitch.md index 35225db23dab..d9d9ce14791d 100644 --- a/docs/plugins/reference/twitch.md +++ b/docs/plugins/reference/twitch.md @@ -16,7 +16,7 @@ OpenClaw Twitch channel plugin for chat and moderation workflows. ## Surface -channels: twitch +channels: `twitch` ## Related docs diff --git a/docs/plugins/reference/venice.md b/docs/plugins/reference/venice.md index 20f6c8868dc5..ef207f5432a3 100644 --- a/docs/plugins/reference/venice.md +++ b/docs/plugins/reference/venice.md @@ -16,7 +16,7 @@ Adds Venice model provider support to OpenClaw. ## Surface -providers: venice; contracts: usageProviders +providers: `venice`; contracts: `usageProviders` ## Related docs diff --git a/docs/plugins/reference/vercel-ai-gateway.md b/docs/plugins/reference/vercel-ai-gateway.md index 1f8d6a8fff6b..23437e3389f5 100644 --- a/docs/plugins/reference/vercel-ai-gateway.md +++ b/docs/plugins/reference/vercel-ai-gateway.md @@ -16,7 +16,7 @@ Adds Vercel AI Gateway model provider support to OpenClaw. ## Surface -providers: vercel-ai-gateway +providers: `vercel-ai-gateway` ## Related docs diff --git a/docs/plugins/reference/vllm.md b/docs/plugins/reference/vllm.md index b2a898aa2935..30d6a21a3e73 100644 --- a/docs/plugins/reference/vllm.md +++ b/docs/plugins/reference/vllm.md @@ -16,7 +16,7 @@ Adds vLLM model provider support to OpenClaw. ## Surface -providers: vllm +providers: `vllm` ## Related docs diff --git a/docs/plugins/reference/voice-call.md b/docs/plugins/reference/voice-call.md index 4cf84cf1d48b..36b8a33e50ea 100644 --- a/docs/plugins/reference/voice-call.md +++ b/docs/plugins/reference/voice-call.md @@ -16,7 +16,7 @@ OpenClaw voice-call plugin for Twilio, Telnyx, and Plivo phone calls. ## Surface -contracts: tools; skills +contracts: `tools`; skills ## Related docs diff --git a/docs/plugins/reference/volcengine.md b/docs/plugins/reference/volcengine.md index ef4811ddc278..17e5109064bb 100644 --- a/docs/plugins/reference/volcengine.md +++ b/docs/plugins/reference/volcengine.md @@ -16,7 +16,7 @@ Adds Volcengine, Volcengine Plan model provider support to OpenClaw. ## Surface -providers: volcengine, volcengine-plan; contracts: speechProviders +providers: `volcengine`, `volcengine-plan`; contracts: `speechProviders` ## Related docs diff --git a/docs/plugins/reference/voyage.md b/docs/plugins/reference/voyage.md index 720a8f0fce05..c4952f1d67fd 100644 --- a/docs/plugins/reference/voyage.md +++ b/docs/plugins/reference/voyage.md @@ -16,4 +16,4 @@ Adds memory embedding provider support. ## Surface -contracts: memoryEmbeddingProviders +contracts: `memoryEmbeddingProviders` diff --git a/docs/plugins/reference/vydra.md b/docs/plugins/reference/vydra.md index 0ecf21a2b7a4..be5dc7d3cd22 100644 --- a/docs/plugins/reference/vydra.md +++ b/docs/plugins/reference/vydra.md @@ -16,7 +16,7 @@ Adds Vydra model provider support to OpenClaw. ## Surface -providers: vydra; contracts: imageGenerationProviders, speechProviders, videoGenerationProviders +providers: `vydra`; contracts: `imageGenerationProviders`, `speechProviders`, `videoGenerationProviders` ## Related docs diff --git a/docs/plugins/reference/web-readability.md b/docs/plugins/reference/web-readability.md index 793516b68ac1..26eafb559719 100644 --- a/docs/plugins/reference/web-readability.md +++ b/docs/plugins/reference/web-readability.md @@ -16,4 +16,4 @@ Extract readable article content from local HTML web fetch responses. ## Surface -contracts: webContentExtractors +contracts: `webContentExtractors` diff --git a/docs/plugins/reference/whatsapp.md b/docs/plugins/reference/whatsapp.md index d056f8d18449..b04083aa32a7 100644 --- a/docs/plugins/reference/whatsapp.md +++ b/docs/plugins/reference/whatsapp.md @@ -16,7 +16,7 @@ OpenClaw WhatsApp channel plugin for WhatsApp Web chats. ## Surface -channels: whatsapp; contracts: tools; skills +channels: `whatsapp`; contracts: `tools`; skills ## Related docs diff --git a/docs/plugins/reference/workboard.md b/docs/plugins/reference/workboard.md index 58449b1b48c5..00e7962e3df9 100644 --- a/docs/plugins/reference/workboard.md +++ b/docs/plugins/reference/workboard.md @@ -16,7 +16,7 @@ Dashboard workboard for agent-owned issues and sessions. ## Surface -contracts: tools +contracts: `tools` ## Related docs diff --git a/docs/plugins/reference/workspaces.md b/docs/plugins/reference/workspaces.md index 85f50be38f92..0014e2083f02 100644 --- a/docs/plugins/reference/workspaces.md +++ b/docs/plugins/reference/workspaces.md @@ -16,4 +16,4 @@ Agent-composable Workspaces document and control-plane backend. ## Surface -contracts: tools +contracts: `tools` diff --git a/docs/plugins/reference/xai.md b/docs/plugins/reference/xai.md index 3dd7d8a6321b..eb5c9f14f488 100644 --- a/docs/plugins/reference/xai.md +++ b/docs/plugins/reference/xai.md @@ -16,7 +16,7 @@ Adds xAI model provider support to OpenClaw. ## Surface -providers: xai; contracts: imageGenerationProviders, mediaUnderstandingProviders, realtimeTranscriptionProviders, realtimeVoiceProviders, speechProviders, tools, videoGenerationProviders, webSearchProviders +providers: `xai`; contracts: `imageGenerationProviders`, `mediaUnderstandingProviders`, `realtimeTranscriptionProviders`, `realtimeVoiceProviders`, `speechProviders`, `tools`, `videoGenerationProviders`, `webSearchProviders` ## Related docs diff --git a/docs/plugins/reference/xiaomi.md b/docs/plugins/reference/xiaomi.md index d02ccf21c155..97fd54230ef1 100644 --- a/docs/plugins/reference/xiaomi.md +++ b/docs/plugins/reference/xiaomi.md @@ -16,7 +16,7 @@ Adds Xiaomi, Xiaomi Token Plan model provider support to OpenClaw. ## Surface -providers: xiaomi, xiaomi-token-plan; contracts: speechProviders, usageProviders +providers: `xiaomi`, `xiaomi-token-plan`; contracts: `speechProviders`, `usageProviders` ## Related docs diff --git a/docs/plugins/reference/zai.md b/docs/plugins/reference/zai.md index 6f13c365a5bd..c886774a4ce9 100644 --- a/docs/plugins/reference/zai.md +++ b/docs/plugins/reference/zai.md @@ -16,7 +16,7 @@ Adds Z.AI model provider support to OpenClaw. ## Surface -providers: zai; contracts: mediaUnderstandingProviders, usageProviders +providers: `zai`; contracts: `mediaUnderstandingProviders`, `usageProviders` ## Related docs diff --git a/docs/plugins/reference/zalo.md b/docs/plugins/reference/zalo.md index 1b07f955eda2..2cc060bbf1a8 100644 --- a/docs/plugins/reference/zalo.md +++ b/docs/plugins/reference/zalo.md @@ -16,7 +16,7 @@ OpenClaw Zalo channel plugin for bot and webhook chats. ## Surface -channels: zalo +channels: `zalo` ## Related docs diff --git a/docs/plugins/reference/zalouser.md b/docs/plugins/reference/zalouser.md index e63c3cb7de59..b37d5b10f393 100644 --- a/docs/plugins/reference/zalouser.md +++ b/docs/plugins/reference/zalouser.md @@ -16,7 +16,7 @@ OpenClaw Zalo Personal Account plugin via native zca-js integration. ## Surface -channels: zalouser; contracts: tools +channels: `zalouser`; contracts: `tools` ## Related docs diff --git a/scripts/generate-plugin-inventory-doc.mjs b/scripts/generate-plugin-inventory-doc.mjs index 1f8a06f1101f..5782513f03d0 100644 --- a/scripts/generate-plugin-inventory-doc.mjs +++ b/scripts/generate-plugin-inventory-doc.mjs @@ -3,6 +3,7 @@ import fs from "node:fs"; import path from "node:path"; import process from "node:process"; +import { resolvePluginSurface } from "./lib/plugin-inventory-doc.mjs"; const DOC_PATH = "docs/plugins/plugin-inventory.md"; const REFERENCE_INDEX_PATH = "docs/plugins/reference.md"; @@ -335,29 +336,6 @@ function resolveDocs({ dirName, manifest, packageJson }) { return links; } -function resolveSurface(manifest) { - const parts = []; - if (Array.isArray(manifest.channels) && manifest.channels.length > 0) { - parts.push(`channels: ${manifest.channels.join(", ")}`); - } - if (Array.isArray(manifest.providers) && manifest.providers.length > 0) { - parts.push(`providers: ${manifest.providers.join(", ")}`); - } - const contracts = Object.keys(manifest.contracts ?? {}).toSorted((left, right) => - left.localeCompare(right), - ); - if (contracts.length > 0) { - parts.push(`contracts: ${contracts.join(", ")}`); - } - if (Array.isArray(manifest.skills) && manifest.skills.length > 0) { - parts.push("skills"); - } - if (parts.length === 0) { - return "plugin"; - } - return parts.join("; "); -} - function resolveInstallRoute(packageJson, status) { if (status === "source") { return "source checkout only"; @@ -578,7 +556,7 @@ function collectPluginRecords() { name: humanizeId(id), packageName: packageJson.name ?? "-", status, - surface: resolveSurface(manifest), + surface: resolvePluginSurface(manifest), }); } diff --git a/scripts/lib/plugin-inventory-doc.d.mts b/scripts/lib/plugin-inventory-doc.d.mts new file mode 100644 index 000000000000..181cbb4c140d --- /dev/null +++ b/scripts/lib/plugin-inventory-doc.d.mts @@ -0,0 +1,9 @@ +export type PluginSurfaceManifest = { + channels?: string[]; + providers?: string[]; + contracts?: Record; + skills?: unknown[]; +}; + +/** Render translatable surface labels with exact manifest identifiers as inline code. */ +export function resolvePluginSurface(manifest: PluginSurfaceManifest): string; diff --git a/scripts/lib/plugin-inventory-doc.mjs b/scripts/lib/plugin-inventory-doc.mjs new file mode 100644 index 000000000000..f42d72dc8c14 --- /dev/null +++ b/scripts/lib/plugin-inventory-doc.mjs @@ -0,0 +1,26 @@ +function formatIdentifiers(values) { + return values.map((value) => `\`${value}\``).join(", "); +} + +export function resolvePluginSurface(manifest) { + const parts = []; + if (Array.isArray(manifest.channels) && manifest.channels.length > 0) { + parts.push(`channels: ${formatIdentifiers(manifest.channels)}`); + } + if (Array.isArray(manifest.providers) && manifest.providers.length > 0) { + parts.push(`providers: ${formatIdentifiers(manifest.providers)}`); + } + const contracts = Object.keys(manifest.contracts ?? {}).toSorted((left, right) => + left.localeCompare(right), + ); + if (contracts.length > 0) { + parts.push(`contracts: ${formatIdentifiers(contracts)}`); + } + if (Array.isArray(manifest.skills) && manifest.skills.length > 0) { + parts.push("skills"); + } + if (parts.length === 0) { + return "plugin"; + } + return parts.join("; "); +} diff --git a/test/scripts/plugin-inventory-doc.test.ts b/test/scripts/plugin-inventory-doc.test.ts new file mode 100644 index 000000000000..cde815407557 --- /dev/null +++ b/test/scripts/plugin-inventory-doc.test.ts @@ -0,0 +1,24 @@ +import { describe, expect, it } from "vitest"; +import { resolvePluginSurface } from "../../scripts/lib/plugin-inventory-doc.mjs"; + +describe("resolvePluginSurface", () => { + it("keeps manifest identifiers as inline code while leaving labels visible", () => { + expect( + resolvePluginSurface({ + channels: ["discord"], + providers: ["openai"], + contracts: { + webSearchProviders: {}, + tools: {}, + }, + skills: ["example"], + }), + ).toBe( + "channels: `discord`; providers: `openai`; contracts: `tools`, `webSearchProviders`; skills", + ); + }); + + it("retains the generic fallback", () => { + expect(resolvePluginSurface({})).toBe("plugin"); + }); +});