opentool 0.8.27 → 0.8.28

package/README.md

@@ -74,6 +74,10 @@ For private tools, say for internal trading apps:
 - GET-only (scheduled default profile)
 - POST-only (one-off, parameterized with Zod)
 - `profile.category` defaults to `tracker` if omitted; set to `strategy` or `orchestrator` for PnL/automation tools.
+- Strategy tools must define `profile.templatePreview` with:
+- `subtitle` (required short line)
+- `description` (required multi-line summary, 3-8 non-empty lines; target ~5)
+- `title` is optional and defaults to the tool name when omitted.
 
 GET-only (scheduled default)
 
@@ -83,6 +87,16 @@ export const profile = {
   description: "Stake 100 USDC daily at 12:00 UTC",
   category: "strategy",
   schedule: { cron: "0 12 * * *", enabled: false },
+  templatePreview: {
+    subtitle: "Automated daily staking strategy",
+    description: [
+      "Runs once per day on your configured schedule.",
+      "Uses fixed, explicit sizing controls from template config.",
+      "Designed for long-running automated execution.",
+      "Keeps logic deterministic and easy to audit.",
+      "Best for hands-off recurring onchain actions.",
+    ].join("\\n"),
+  },
 };
 
 export async function GET(_req: Request) {

package/dist/cli/index.d.ts

@@ -1,6 +1,6 @@
 #!/usr/bin/env node
-import { M as Metadata, I as InternalToolDefinition } from '../validate-C4a9tmrQ.js';
-export { G as GenerateMetadataOptions, a as GenerateMetadataResult, V as ValidateOptions, b as generateMetadata, g as generateMetadataCommand, l as loadAndValidateTools, v as validateCommand, c as validateFullCommand } from '../validate-C4a9tmrQ.js';
+import { M as Metadata, I as InternalToolDefinition } from '../validate-3WEA0Ezt.js';
+export { G as GenerateMetadataOptions, a as GenerateMetadataResult, V as ValidateOptions, b as generateMetadata, g as generateMetadataCommand, l as loadAndValidateTools, v as validateCommand, c as validateFullCommand } from '../validate-3WEA0Ezt.js';
 import 'zod';
 import '../x402/index.js';
 import 'viem';

package/dist/cli/index.js

@@ -1002,6 +1002,11 @@ var SUPPORTED_EXTENSIONS = [
   ".cjs"
 ];
 var MIN_TEMPLATE_CONFIG_VERSION = 2;
+var TEMPLATE_PREVIEW_TITLE_MAX = 80;
+var TEMPLATE_PREVIEW_SUBTITLE_MAX = 120;
+var TEMPLATE_PREVIEW_DESCRIPTION_MAX = 1200;
+var TEMPLATE_PREVIEW_MIN_LINES = 3;
+var TEMPLATE_PREVIEW_MAX_LINES = 8;
 function normalizeTemplateConfigVersion(value) {
   if (typeof value === "number" && Number.isFinite(value)) {
     return value;
@@ -1024,6 +1029,67 @@ function normalizeTemplateConfigVersion(value) {
   const major = Number.parseInt(majorMatch[1], 10);
   return Number.isFinite(major) ? major : null;
 }
+function parseNonEmptyString(value, fieldPath, opts = {}) {
+  const { max, required = false } = opts;
+  if (value == null) {
+    if (required) {
+      throw new Error(`${fieldPath} is required and must be a non-empty string.`);
+    }
+    return null;
+  }
+  if (typeof value !== "string") {
+    throw new Error(`${fieldPath} must be a string.`);
+  }
+  const trimmed = value.trim();
+  if (!trimmed) {
+    throw new Error(`${fieldPath} must be a non-empty string.`);
+  }
+  if (typeof max === "number" && trimmed.length > max) {
+    throw new Error(`${fieldPath} must be <= ${max} characters.`);
+  }
+  return trimmed;
+}
+function normalizeTemplatePreview(value, file, toolName, requirePreview) {
+  const pathPrefix = `${file}: profile.templatePreview`;
+  if (value == null) {
+    if (requirePreview) {
+      throw new Error(
+        `${pathPrefix} is required for strategy tools and must define subtitle + description.`
+      );
+    }
+    return null;
+  }
+  if (!value || typeof value !== "object" || Array.isArray(value)) {
+    throw new Error(`${pathPrefix} must be an object.`);
+  }
+  const record = value;
+  const title = parseNonEmptyString(record.title, `${pathPrefix}.title`, {
+    max: TEMPLATE_PREVIEW_TITLE_MAX
+  }) ?? toolName;
+  const subtitle = parseNonEmptyString(record.subtitle, `${pathPrefix}.subtitle`, {
+    required: true,
+    max: TEMPLATE_PREVIEW_SUBTITLE_MAX
+  });
+  const description = parseNonEmptyString(
+    record.description,
+    `${pathPrefix}.description`,
+    {
+      required: true,
+      max: TEMPLATE_PREVIEW_DESCRIPTION_MAX
+    }
+  );
+  const descriptionLineCount = description.split(/\r?\n/).map((line) => line.trim()).filter((line) => line.length > 0).length;
+  if (descriptionLineCount < TEMPLATE_PREVIEW_MIN_LINES || descriptionLineCount > TEMPLATE_PREVIEW_MAX_LINES) {
+    throw new Error(
+      `${pathPrefix}.description must contain ${TEMPLATE_PREVIEW_MIN_LINES}-${TEMPLATE_PREVIEW_MAX_LINES} non-empty lines (target ~5 lines).`
+    );
+  }
+  return {
+    title,
+    subtitle,
+    description
+  };
+}
 async function validateCommand(options) {
   console.log("\u{1F50D} Validating OpenTool metadata...");
   try {
@@ -1135,16 +1201,26 @@ async function loadAndValidateTools(toolsDir, options = {}) {
         throw new Error(`${file}: export exactly one of GET or POST`);
       }
       let normalizedSchedule = null;
-      const schedule = toolModule?.profile?.schedule;
-      const profileNotifyEmail = typeof toolModule?.profile?.notifyEmail === "boolean" ? toolModule.profile.notifyEmail : void 0;
-      const profileCategoryRaw = typeof toolModule?.profile?.category === "string" ? toolModule.profile.category : void 0;
-      const allowedProfileCategories = /* @__PURE__ */ new Set(["strategy", "tracker", "orchestrator"]);
-      if (profileCategoryRaw && !allowedProfileCategories.has(profileCategoryRaw)) {
-        throw new Error(
-          `${file}: profile.category must be one of ${Array.from(allowedProfileCategories).join(", ")}`
-        );
+      const profileRaw = toolModule?.profile && typeof toolModule.profile === "object" ? toolModule.profile : null;
+      const schedule = profileRaw?.schedule ?? null;
+      const profileNotifyEmail = typeof profileRaw?.notifyEmail === "boolean" ? profileRaw.notifyEmail : void 0;
+      const allowedProfileCategories = [
+        "strategy",
+        "tracker",
+        "orchestrator"
+      ];
+      const profileCategoryCandidate = typeof profileRaw?.category === "string" ? profileRaw.category : void 0;
+      let profileCategoryRaw;
+      if (profileCategoryCandidate !== void 0) {
+        const isAllowed = allowedProfileCategories.includes(profileCategoryCandidate);
+        if (!isAllowed) {
+          throw new Error(
+            `${file}: profile.category must be one of ${allowedProfileCategories.join(", ")}`
+          );
+        }
+        profileCategoryRaw = profileCategoryCandidate;
       }
-      const profileAssetsRaw = toolModule?.profile?.assets;
+      const profileAssetsRaw = profileRaw?.assets;
       if (profileAssetsRaw !== void 0) {
         if (!Array.isArray(profileAssetsRaw)) {
           throw new Error(`${file}: profile.assets must be an array.`);
@@ -1202,7 +1278,7 @@ async function loadAndValidateTools(toolsDir, options = {}) {
           }
         });
       }
-      const templateConfigRaw = toolModule?.profile?.templateConfig;
+      const templateConfigRaw = profileRaw?.templateConfig;
       if (templateConfigRaw !== void 0) {
         if (!templateConfigRaw || typeof templateConfigRaw !== "object") {
           throw new Error(`${file}: profile.templateConfig must be an object.`);
@@ -1239,6 +1315,13 @@ async function loadAndValidateTools(toolsDir, options = {}) {
           );
         }
       }
+      const normalizedTemplatePreview = normalizeTemplatePreview(
+        profileRaw?.templatePreview,
+        file,
+        toolName,
+        profileCategoryRaw === "strategy"
+      );
+      const normalizedProfile = profileRaw && normalizedTemplatePreview ? { ...profileRaw, templatePreview: normalizedTemplatePreview } : profileRaw;
       if (hasGET && schedule && typeof schedule.cron === "string" && schedule.cron.trim().length > 0) {
         normalizedSchedule = normalizeScheduleExpression(schedule.cron, file);
         if (typeof schedule.enabled === "boolean") {
@@ -1308,9 +1391,9 @@ async function loadAndValidateTools(toolsDir, options = {}) {
         handler: async (params) => adapter(params),
         payment: paymentExport ?? null,
         schedule: normalizedSchedule,
-        profile: toolModule?.profile && typeof toolModule.profile === "object" ? toolModule.profile : null,
+        profile: normalizedProfile,
         ...profileNotifyEmail !== void 0 ? { notifyEmail: profileNotifyEmail } : {},
-        profileDescription: typeof toolModule?.profile?.description === "string" ? toolModule.profile?.description ?? null : null,
+        profileDescription: typeof profileRaw?.description === "string" ? profileRaw.description : null,
         ...profileCategoryRaw ? { profileCategory: profileCategoryRaw } : {}
       };
       tools.push(tool);