opentool 0.8.5 → 0.8.7

package/README.md

@@ -73,6 +73,7 @@ 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` for PnL/automation tools.
 
 GET-only (scheduled default)
 
@@ -80,6 +81,7 @@ GET-only (scheduled default)
 // tools/aave-stake.ts
 export const profile = {
   description: "Stake 100 USDC daily at 12:00 UTC",
+  category: "strategy",
   fixedAmount: "100",
   tokenSymbol: "USDC",
   schedule: { cron: "0 12 * * *", enabled: false },
@@ -103,6 +105,12 @@ POST-only (one-off)
 // tools/aave-unstake.ts
 import { z } from "zod";
 
+export const profile = {
+  description: "Unstake USDC on demand",
+  category: "tracker",
+  notifyEmail: true,
+};
+
 export const schema = z.object({
   amount: z.string(),
   token: z.string().default("USDC"),
@@ -115,10 +123,16 @@ export async function POST(req: Request) {
 }
 ```
 
+### Email notifications for one-off tools
+
+- POST-only tools can set `profile.notifyEmail = true` to request an email when the tool runs.
+- Scheduled tools should continue to use `profile.schedule.notifyEmail`.
+
 ### Cron schedules (`profile.schedule`)
 
 - GET-only tools require `profile.schedule` with a standard 5–6 field cron expression (e.g., `0 12 * * *` or `0 0 ? * MON-FRI *`).
 - Build validates the cron shape and emits `.well-known/opentool/cron.json` capturing each scheduled tool (`toolName`, `toolPath`, `scheduleExpression`). Enabled defaults to `false` even if authors set it to `true` in code. Deployment targets can translate these cron strings to their provider format (e.g., EventBridge) downstream.
+- Use `profile.schedule.notifyEmail = true` to request email delivery on schedule runs.
 
 ### Public tools: Add x402 payments (optional)
 

package/dist/cli/index.d.ts

@@ -1,6 +1,6 @@
 #!/usr/bin/env node
-import { M as Metadata, I as InternalToolDefinition } from '../validate-BJ5-5n8h.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-BJ5-5n8h.js';
+import { M as Metadata, I as InternalToolDefinition } from '../validate-3e5UvzfQ.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-3e5UvzfQ.js';
 import 'zod';
 import '../x402/index.js';
 import 'viem';

package/dist/cli/index.js

@@ -139,6 +139,7 @@ var DiscoveryMetadataSchema = z.object({
   compatibility: z.record(z.string(), z.any()).optional(),
   documentation: z.union([z.string(), z.array(z.string())]).optional()
 }).catchall(z.any());
+var ToolCategorySchema = z.enum(["strategy", "tracker"]);
 var ToolMetadataOverridesSchema = z.object({
   name: z.string().optional(),
   description: z.string().optional(),
@@ -154,7 +155,9 @@ var ToolSchema = z.object({
   annotations: McpAnnotationsSchema.optional(),
   payment: PaymentConfigSchema.optional(),
   discovery: DiscoveryMetadataSchema.optional(),
-  chains: z.array(z.union([z.string(), z.number()])).optional()
+  chains: z.array(z.union([z.string(), z.number()])).optional(),
+  notifyEmail: z.boolean().optional(),
+  category: ToolCategorySchema.optional()
 }).strict();
 var MetadataSchema = z.object({
   metadataSpecVersion: z.string().optional(),
@@ -340,6 +343,10 @@ async function buildMetadataArtifact(options) {
     }
     const toolDiscovery = overrides.discovery ?? void 0;
     const toolChains = overrides.chains ?? authored.chains ?? void 0;
+    const toolCategory = tool.profileCategory ?? "tracker";
+    if (!tool.profileCategory) {
+      defaultsApplied.push(`tool ${toolName} category \u2192 tracker (default)`);
+    }
     const toolDefinition = {
       name: toolName,
       description: toolDescription,
@@ -357,6 +364,14 @@ async function buildMetadataArtifact(options) {
     if (toolChains) {
       toolDefinition.chains = toolChains;
     }
+    toolDefinition.category = toolCategory;
+    const notifyEmail = tool.notifyEmail ?? tool.schedule?.notifyEmail;
+    if (notifyEmail !== void 0) {
+      toolDefinition.notifyEmail = notifyEmail;
+    }
+    if (tool.profileCategory) {
+      toolDefinition.category = tool.profileCategory;
+    }
     return toolDefinition;
   });
   const metadata = BuildMetadataSchema.parse({
@@ -1093,6 +1108,14 @@ async function loadAndValidateTools(toolsDir, options = {}) {
       }
       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"]);
+      if (profileCategoryRaw && !allowedProfileCategories.has(profileCategoryRaw)) {
+        throw new Error(
+          `${file}: profile.category must be one of ${Array.from(allowedProfileCategories).join(", ")}`
+        );
+      }
       if (hasGET && schedule && typeof schedule.cron === "string" && schedule.cron.trim().length > 0) {
         normalizedSchedule = normalizeScheduleExpression(schedule.cron, file);
         if (typeof schedule.enabled === "boolean") {
@@ -1162,7 +1185,9 @@ async function loadAndValidateTools(toolsDir, options = {}) {
         handler: async (params) => adapter(params),
         payment: paymentExport ?? null,
         schedule: normalizedSchedule,
-        profileDescription: typeof toolModule?.profile?.description === "string" ? toolModule.profile?.description ?? null : null
+        ...profileNotifyEmail !== void 0 ? { notifyEmail: profileNotifyEmail } : {},
+        profileDescription: typeof toolModule?.profile?.description === "string" ? toolModule.profile?.description ?? null : null,
+        ...profileCategoryRaw ? { profileCategory: profileCategoryRaw } : {}
       };
       tools.push(tool);
     }