fix(agents): ignore unsupported music generation hints

Author: steipete

CHANGELOG.md

@@ -11,6 +11,7 @@ Docs: https://docs.openclaw.ai
 ### Changes
 
 - Agents/video generation: add the built-in `video_generate` tool so agents can create videos through configured providers and return the generated media directly in the reply.
+- Agents/music generation: ignore unsupported optional hints such as `durationSeconds` with a warning instead of hard-failing requests on providers like Google Lyria.
 - Providers/ComfyUI: add a bundled `comfy` workflow media plugin for local ComfyUI and Comfy Cloud workflows, including shared `image_generate`, `video_generate`, and workflow-backed `music_generate` support, with prompt injection, optional reference-image upload, live tests, and output download.
 - Tools/music generation: add the built-in `music_generate` tool with bundled Google (Lyria) and MiniMax providers plus workflow-backed Comfy support, including async task tracking and follow-up delivery of finished audio.
 - Providers: add bundled Qwen, Fireworks AI, and StepFun providers, plus MiniMax TTS, Ollama Web Search, and MiniMax Search integrations for chat, speech, and search workflows. (#60032, #55921, #59318, #54648)

docs/tools/music-generation.md

@@ -119,8 +119,9 @@ Direct generation example:
 | `format`          | string   | Output format hint (`mp3` or `wav`) when the provider supports it                                 |
 | `filename`        | string   | Output filename hint                                                                              |
 
-Not all providers support all parameters. The shared tool validates provider
-capability limits before it submits the request.
+Not all providers support all parameters. OpenClaw still validates hard limits
+such as input counts before submission, but unsupported optional hints are
+ignored with a warning when the selected provider or model cannot honor them.
 
 ## Async behavior for the shared provider-backed path
 

src/agents/tools/music-generate-tool.test.ts

@@ -75,6 +75,7 @@ describe("createMusicGenerateTool", () => {
       provider: "google",
       model: "lyria-3-clip-preview",
       attempts: [],
+      ignoredOverrides: [],
       tracks: [
         {
           buffer: Buffer.from("music-bytes"),
@@ -154,6 +155,7 @@ describe("createMusicGenerateTool", () => {
       provider: "google",
       model: "lyria-3-clip-preview",
       attempts: [],
+      ignoredOverrides: [],
       tracks: [
         {
           buffer: Buffer.from("music-bytes"),
@@ -270,4 +272,86 @@ describe("createMusicGenerateTool", () => {
     expect(text).toContain("supportedFormats=mp3");
     expect(text).toContain("instrumental");
   });
+
+  it("warns when optional provider overrides are ignored", async () => {
+    vi.spyOn(musicGenerationRuntime, "listRuntimeMusicGenerationProviders").mockReturnValue([
+      {
+        id: "google",
+        defaultModel: "lyria-3-clip-preview",
+        models: ["lyria-3-clip-preview"],
+        capabilities: {
+          supportsLyrics: true,
+          supportsInstrumental: true,
+          supportsFormat: true,
+          supportedFormatsByModel: {
+            "lyria-3-clip-preview": ["mp3"],
+          },
+        },
+        generateMusic: vi.fn(async () => {
+          throw new Error("not used");
+        }),
+      },
+    ]);
+    vi.spyOn(musicGenerationRuntime, "generateMusic").mockResolvedValue({
+      provider: "google",
+      model: "lyria-3-clip-preview",
+      attempts: [],
+      ignoredOverrides: [
+        { key: "durationSeconds", value: 30 },
+        { key: "format", value: "wav" },
+      ],
+      tracks: [
+        {
+          buffer: Buffer.from("music-bytes"),
+          mimeType: "audio/mpeg",
+          fileName: "molty-anthem.mp3",
+        },
+      ],
+    });
+    vi.spyOn(mediaStore, "saveMediaBuffer").mockResolvedValueOnce({
+      path: "/tmp/molty-anthem.mp3",
+      id: "molty-anthem.mp3",
+      size: 11,
+      contentType: "audio/mpeg",
+    });
+
+    const tool = createMusicGenerateTool({
+      config: asConfig({
+        agents: {
+          defaults: {
+            musicGenerationModel: { primary: "google/lyria-3-clip-preview" },
+          },
+        },
+      }),
+    });
+    if (!tool) {
+      throw new Error("expected music_generate tool");
+    }
+
+    const result = await tool.execute("call-google-generate", {
+      prompt: "OpenClaw anthem",
+      instrumental: true,
+      durationSeconds: 30,
+      format: "wav",
+    });
+    const text = (result.content?.[0] as { text: string } | undefined)?.text ?? "";
+
+    expect(text).toContain("Generated 1 track with google/lyria-3-clip-preview.");
+    expect(text).toContain(
+      "Warning: Ignored unsupported overrides for google/lyria-3-clip-preview: durationSeconds=30, format=wav.",
+    );
+    expect(result).toMatchObject({
+      details: {
+        instrumental: true,
+        warning:
+          "Ignored unsupported overrides for google/lyria-3-clip-preview: durationSeconds=30, format=wav.",
+        ignoredOverrides: [
+          { key: "durationSeconds", value: 30 },
+          { key: "format", value: "wav" },
+        ],
+      },
+    });
+    expect(result.details).not.toHaveProperty("durationSeconds");
+    expect(result.details).not.toHaveProperty("format");
+  });
 });

src/agents/tools/music-generate-tool.ts

@@ -222,34 +222,17 @@ function validateMusicGenerationCapabilities(params: {
       );
     }
   }
-  if (params.lyrics?.trim() && !caps.supportsLyrics) {
-    throw new ToolInputError(`${provider.id} does not support explicit lyrics input.`);
-  }
-  if (typeof params.instrumental === "boolean" && !caps.supportsInstrumental) {
-    throw new ToolInputError(`${provider.id} does not support instrumental toggles.`);
-  }
-  if (typeof params.durationSeconds === "number" && !caps.supportsDuration) {
-    throw new ToolInputError(`${provider.id} does not support duration hints.`);
-  }
-  if (typeof params.durationSeconds === "number" && typeof caps.maxDurationSeconds === "number") {
+  if (
+    typeof params.durationSeconds === "number" &&
+    caps.supportsDuration &&
+    typeof caps.maxDurationSeconds === "number"
+  ) {
     if (params.durationSeconds > caps.maxDurationSeconds) {
       throw new ToolInputError(
         `${provider.id} supports at most ${caps.maxDurationSeconds} seconds per track.`,
       );
     }
   }
-  if (params.format) {
-    if (!caps.supportsFormat) {
-      throw new ToolInputError(`${provider.id} does not support explicit output-format overrides.`);
-    }
-    const supportedFormats =
-      caps.supportedFormatsByModel?.[params.model ?? ""] ?? caps.supportedFormats ?? [];
-    if (supportedFormats.length > 0 && !supportedFormats.includes(params.format)) {
-      throw new ToolInputError(
-        `${provider.id} supports ${supportedFormats.join(", ")} output${params.model ? ` for ${params.model}` : ""}.`,
-      );
-    }
-  }
 }
 
 type MusicGenerateSandboxConfig = {
@@ -419,8 +402,15 @@ async function executeMusicGenerationJob(params: {
       ),
     ),
   );
+  const ignoredOverrides = result.ignoredOverrides ?? [];
+  const ignoredOverrideKeys = new Set(ignoredOverrides.map((entry) => entry.key));
+  const warning =
+    ignoredOverrides.length > 0
+      ? `Ignored unsupported overrides for ${result.provider}/${result.model}: ${ignoredOverrides.map((entry) => `${entry.key}=${String(entry.value)}`).join(", ")}.`
+      : undefined;
   const lines = [
     `Generated ${savedTracks.length} track${savedTracks.length === 1 ? "" : "s"} with ${result.provider}/${result.model}.`,
+    ...(warning ? [`Warning: ${warning}`] : []),
     ...(result.lyrics?.length ? ["Lyrics returned.", ...result.lyrics] : []),
     ...savedTracks.map((track) => `MEDIA:${track.path}`),
   ];
@@ -446,12 +436,16 @@ async function executeMusicGenerationJob(params: {
             },
           }
         : {}),
-      ...(params.lyrics ? { requestedLyrics: params.lyrics } : {}),
-      ...(typeof params.instrumental === "boolean" ? { instrumental: params.instrumental } : {}),
-      ...(typeof params.durationSeconds === "number"
+      ...(!ignoredOverrideKeys.has("lyrics") && params.lyrics
+        ? { requestedLyrics: params.lyrics }
+        : {}),
+      ...(!ignoredOverrideKeys.has("instrumental") && typeof params.instrumental === "boolean"
+        ? { instrumental: params.instrumental }
+        : {}),
+      ...(!ignoredOverrideKeys.has("durationSeconds") && typeof params.durationSeconds === "number"
         ? { durationSeconds: params.durationSeconds }
         : {}),
-      ...(params.format ? { format: params.format } : {}),
+      ...(!ignoredOverrideKeys.has("format") && params.format ? { format: params.format } : {}),
       ...(params.filename ? { filename: params.filename } : {}),
       ...(params.loadedReferenceImages.length === 1
         ? {
@@ -471,6 +465,8 @@ async function executeMusicGenerationJob(params: {
       ...(result.lyrics?.length ? { lyrics: result.lyrics } : {}),
       attempts: result.attempts,
       metadata: result.metadata,
+      ...(warning ? { warning } : {}),
+      ...(ignoredOverrides.length > 0 ? { ignoredOverrides } : {}),
     },
   };
 }