@cozeclaw/coze-openclaw-plugin 0.1.1 → 0.1.3

package/index.ts

@@ -2,11 +2,21 @@ import type { OpenClawPluginApi } from "openclaw/plugin-sdk/core";
 import { createCozeWebFetchTool } from "./src/tools/web-fetch.js";
 import { createCozeWebSearchTool } from "./src/tools/web-search.js";
 
+function hasApiKey(pluginConfig: OpenClawPluginApi["pluginConfig"]): boolean {
+  return typeof pluginConfig?.apiKey === "string" && pluginConfig.apiKey.trim().length > 0;
+}
+
 const plugin = {
   id: "coze-openclaw-plugin",
   name: "Coze OpenClaw Plugin",
   description: "Coze web tools and bundled generation skills for OpenClaw.",
   register(api: OpenClawPluginApi) {
+    if (!hasApiKey(api.pluginConfig)) {
+      api.logger.info?.(
+        "Skipping Coze tool registration because plugins.entries.coze-openclaw-plugin.config.apiKey is missing.",
+      );
+      return;
+    }
     api.registerTool(
       createCozeWebSearchTool({
         pluginConfig: api.pluginConfig,

package/openclaw.plugin.json

@@ -6,7 +6,6 @@
   "configSchema": {
     "type": "object",
     "additionalProperties": false,
-    "required": ["apiKey"],
     "properties": {
       "apiKey": {
         "type": "string"

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "@cozeclaw/coze-openclaw-plugin",
-  "version": "0.1.1",
+  "version": "0.1.3",
   "description": "OpenClaw Coze tools and bundled skills",
   "type": "module",
   "scripts": {
-    "test": "vitest run src/config.test.ts src/skill-cli.test.ts src/tools/web-search.test.ts src/tools/web-fetch.test.ts"
+    "test": "vitest run src/config.test.ts src/plugin.test.ts src/skill-cli.test.ts src/tools/web-search.test.ts src/tools/web-fetch.test.ts"
   },
   "devDependencies": {
     "openclaw": "v2026.2.6",

package/skills/coze-asr/SKILL.md

@@ -12,8 +12,8 @@ Transcribe audio from a URL or local file using Coze ASR.
 ## Quick start
 
 ```bash
-node {baseDir}/scripts/asr.mjs --url "https://example.com/audio.mp3"
-node {baseDir}/scripts/asr.mjs --file ./recording.mp3
+node {skillDir}/scripts/asr.mjs --url "https://example.com/audio.mp3"
+node {skillDir}/scripts/asr.mjs --file ./recording.mp3
 ```
 
 ## Options
@@ -24,4 +24,5 @@ node {baseDir}/scripts/asr.mjs --file ./recording.mp3
 ## Notes
 
 - The skill runtime requires `plugins.entries.coze-openclaw-plugin.config.apiKey`.
+- `{skillDir}` means the directory containing this `SKILL.md`.
 - Local files are read and uploaded as base64 audio content.

package/skills/coze-image-gen/SKILL.md

@@ -12,9 +12,9 @@ Generate one or more images from a prompt using Coze.
 ## Quick start
 
 ```bash
-node {baseDir}/scripts/gen.mjs --prompt "A futuristic city at sunset"
-node {baseDir}/scripts/gen.mjs --prompt "A serene mountain landscape" --count 2 --size 4K
-node {baseDir}/scripts/gen.mjs --prompt "A hero's journey through magical lands" --sequential --max-sequential 5
+node {skillDir}/scripts/gen.mjs --prompt "A futuristic city at sunset"
+node {skillDir}/scripts/gen.mjs --prompt "A serene mountain landscape" --count 2 --size 4K
+node {skillDir}/scripts/gen.mjs --prompt "A hero's journey through magical lands" --sequential --max-sequential 5
 ```
 
 ## Options
@@ -28,4 +28,5 @@ node {baseDir}/scripts/gen.mjs --prompt "A hero's journey through magical lands"
 ## Notes
 
 - The skill runtime requires `plugins.entries.coze-openclaw-plugin.config.apiKey`.
+- `{skillDir}` means the directory containing this `SKILL.md`.
 - URLs are printed directly and are suitable for immediate use.

package/skills/coze-tts/SKILL.md

@@ -12,9 +12,9 @@ Generate speech audio URLs from text using Coze TTS.
 ## Quick start
 
 ```bash
-node {baseDir}/scripts/tts.mjs --text "Hello, welcome to our service"
-node {baseDir}/scripts/tts.mjs --texts "Chapter 1" "Chapter 2" --speaker zh_male_m191_uranus_bigtts
-node {baseDir}/scripts/tts.mjs --text "Fast announcement" --speech-rate 30 --format mp3 --sample-rate 48000
+node {skillDir}/scripts/tts.mjs --text "Hello, welcome to our service"
+node {skillDir}/scripts/tts.mjs --texts "Chapter 1" "Chapter 2" --speaker zh_male_m191_uranus_bigtts
+node {skillDir}/scripts/tts.mjs --text "Fast announcement" --speech-rate 30 --format mp3 --sample-rate 48000
 ```
 
 ## Options
@@ -30,4 +30,5 @@ node {baseDir}/scripts/tts.mjs --text "Fast announcement" --speech-rate 30 --for
 ## Notes
 
 - The skill runtime requires `plugins.entries.coze-openclaw-plugin.config.apiKey`.
+- `{skillDir}` means the directory containing this `SKILL.md`.
 - The script prints one audio URL per generated segment.

package/src/plugin.test.ts

@@ -0,0 +1,62 @@
+import { describe, expect, it, vi } from "vitest";
+import plugin from "../index.js";
+
+function createApi(pluginConfig: Record<string, unknown>) {
+  return {
+    id: "coze-openclaw-plugin",
+    name: "Coze OpenClaw Plugin",
+    description: "Coze OpenClaw",
+    source: "test",
+    config: {},
+    pluginConfig,
+    runtime: {} as never,
+    logger: {
+      debug() {},
+      info: vi.fn(),
+      warn() {},
+      error() {},
+    },
+    registerTool: vi.fn(),
+    registerHook() {},
+    registerHttpRoute() {},
+    registerChannel() {},
+    registerGatewayMethod() {},
+    registerCli() {},
+    registerService() {},
+    registerProvider() {},
+    registerCommand() {},
+    registerContextEngine() {},
+    resolvePath(input: string) {
+      return input;
+    },
+    on() {},
+  };
+}
+
+describe("plugin registration", () => {
+  it("skips tool registration when apiKey is missing", () => {
+    const api = createApi({});
+
+    plugin.register?.(api);
+
+    expect(api.registerTool).not.toHaveBeenCalled();
+    expect(api.logger.info).toHaveBeenCalledWith(
+      "Skipping Coze tool registration because plugins.entries.coze-openclaw-plugin.config.apiKey is missing.",
+    );
+  });
+
+  it("registers coze web tools when apiKey exists", () => {
+    const api = createApi({ apiKey: "test-key" });
+
+    plugin.register?.(api);
+
+    expect(api.registerTool).toHaveBeenCalledTimes(2);
+    const toolNames = api.registerTool.mock.calls
+      .map((call) => {
+        const tool = call[0];
+        return typeof tool === "function" ? undefined : tool.name;
+      })
+      .filter(Boolean);
+    expect(toolNames).toEqual(["coze_web_search", "coze_web_fetch"]);
+  });
+});