llmist 1.4.0 → 1.6.0

package/dist/index.cjs

@@ -857,38 +857,83 @@ function formatParamsAsBlock(params, prefix = "", argPrefix = GADGET_ARG_PREFIX)
   }
   return lines.join("\n");
 }
-function formatSchemaAsPlainText(schema, indent = "") {
+function formatParamLine(key, propObj, isRequired, indent = "") {
+  const type = propObj.type;
+  const description = propObj.description;
+  const enumValues = propObj.enum;
+  let line = `${indent}- ${key}`;
+  if (type === "array") {
+    const items = propObj.items;
+    const itemType = items?.type || "any";
+    line += ` (array of ${itemType})`;
+  } else if (type === "object" && propObj.properties) {
+    line += " (object)";
+  } else {
+    line += ` (${type})`;
+  }
+  if (isRequired && indent !== "") {
+    line += " [required]";
+  }
+  if (description) {
+    line += `: ${description}`;
+  }
+  if (enumValues) {
+    line += ` - one of: ${enumValues.map((v) => `"${v}"`).join(", ")}`;
+  }
+  return line;
+}
+function formatSchemaAsPlainText(schema, indent = "", atRoot = true) {
   const lines = [];
   const properties = schema.properties || {};
   const required = schema.required || [];
-  for (const [key, prop] of Object.entries(properties)) {
-    const propObj = prop;
-    const type = propObj.type;
-    const description = propObj.description;
-    const isRequired = required.includes(key);
-    const enumValues = propObj.enum;
-    let line = `${indent}- ${key}`;
-    if (type === "array") {
-      const items = propObj.items;
-      const itemType = items?.type || "any";
-      line += ` (array of ${itemType})`;
-    } else if (type === "object" && propObj.properties) {
-      line += " (object)";
-    } else {
-      line += ` (${type})`;
+  if (atRoot && indent === "") {
+    const requiredProps = [];
+    const optionalProps = [];
+    for (const [key, prop] of Object.entries(properties)) {
+      if (required.includes(key)) {
+        requiredProps.push([key, prop]);
+      } else {
+        optionalProps.push([key, prop]);
+      }
     }
-    if (isRequired) {
-      line += " [required]";
+    const reqCount = requiredProps.length;
+    const optCount = optionalProps.length;
+    if (reqCount > 0 || optCount > 0) {
+      const parts = [];
+      if (reqCount > 0) parts.push(`${reqCount} required`);
+      if (optCount > 0) parts.push(`${optCount} optional`);
+      lines.push(parts.join(", "));
+      lines.push("");
     }
-    if (description) {
-      line += `: ${description}`;
+    if (reqCount > 0) {
+      lines.push("REQUIRED Parameters:");
+      for (const [key, prop] of requiredProps) {
+        lines.push(formatParamLine(key, prop, true, ""));
+        const propObj = prop;
+        if (propObj.type === "object" && propObj.properties) {
+          lines.push(formatSchemaAsPlainText(propObj, "  ", false));
+        }
+      }
     }
-    if (enumValues) {
-      line += ` - one of: ${enumValues.map((v) => `"${v}"`).join(", ")}`;
+    if (optCount > 0) {
+      if (reqCount > 0) lines.push("");
+      lines.push("OPTIONAL Parameters:");
+      for (const [key, prop] of optionalProps) {
+        lines.push(formatParamLine(key, prop, false, ""));
+        const propObj = prop;
+        if (propObj.type === "object" && propObj.properties) {
+          lines.push(formatSchemaAsPlainText(propObj, "  ", false));
+        }
+      }
     }
-    lines.push(line);
-    if (type === "object" && propObj.properties) {
-      lines.push(formatSchemaAsPlainText(propObj, indent + "  "));
+    return lines.join("\n");
+  }
+  for (const [key, prop] of Object.entries(properties)) {
+    const isRequired = required.includes(key);
+    lines.push(formatParamLine(key, prop, isRequired, indent));
+    const propObj = prop;
+    if (propObj.type === "object" && propObj.properties) {
+      lines.push(formatSchemaAsPlainText(propObj, indent + "  ", false));
     }
   }
   return lines.join("\n");
@@ -939,10 +984,11 @@ var init_gadget = __esm({
        * Generate instruction text for the LLM.
        * Combines name, description, and parameter schema into a formatted instruction.
        *
-       * @param argPrefix - Optional custom argument prefix for block format examples
+       * @param optionsOrArgPrefix - Optional custom prefixes for examples, or just argPrefix string for backwards compatibility
        * @returns Formatted instruction string
        */
-      getInstruction(argPrefix) {
+      getInstruction(optionsOrArgPrefix) {
+        const options = typeof optionsOrArgPrefix === "string" ? { argPrefix: optionsOrArgPrefix } : optionsOrArgPrefix;
         const parts = [];
         parts.push(this.description);
         if (this.parameterSchema) {
@@ -956,18 +1002,25 @@ var init_gadget = __esm({
         }
         if (this.examples && this.examples.length > 0) {
           parts.push("\n\nExamples:");
-          const effectiveArgPrefix = argPrefix ?? GADGET_ARG_PREFIX;
+          const effectiveArgPrefix = options?.argPrefix ?? GADGET_ARG_PREFIX;
+          const effectiveStartPrefix = options?.startPrefix ?? GADGET_START_PREFIX;
+          const effectiveEndPrefix = options?.endPrefix ?? GADGET_END_PREFIX;
+          const gadgetName = this.name || this.constructor.name;
           this.examples.forEach((example, index) => {
             if (index > 0) {
               parts.push("");
+              parts.push("---");
+              parts.push("");
             }
             if (example.comment) {
               parts.push(`# ${example.comment}`);
             }
-            parts.push("Input:");
+            parts.push(`${effectiveStartPrefix}${gadgetName}`);
             parts.push(formatParamsAsBlock(example.params, "", effectiveArgPrefix));
+            parts.push(effectiveEndPrefix);
             if (example.output !== void 0) {
-              parts.push("Output:");
+              parts.push("");
+              parts.push("Expected Output:");
               parts.push(example.output);
             }
           });