fmp-ai-tools 0.2.3 → 0.2.4-beta.1

package/dist/providers/vercel-ai/index.mjs

@@ -190,6 +190,11 @@ function toToolResponse(res) {
   }
   return JSON.stringify(res.data, null, 2);
 }
+function limitRows(res, limit2, compare) {
+  if (res.success === false || !Array.isArray(res.data)) return res;
+  const rows = compare ? [...res.data].sort(compare) : res.data;
+  return { ...res, data: rows.slice(0, limit2) };
+}
 function toToolError(error) {
   const message = error instanceof Error ? error.message : String(error);
   let type = "unknown";
@@ -329,9 +334,11 @@ var companyDefinitions = [
   }),
   defineTool({
     name: "getCompanyExecutiveCompensation",
-    description: "Get the company executive compensation",
-    inputSchema: symbolSchema,
-    execute: async ({ symbol: symbol2 }) => toToolResponse(await getFMPClient().company.getExecutiveCompensation(symbol2))
+    description: "Get the company executive compensation (at most `limit` records)",
+    inputSchema: symbolSchema.extend({
+      limit: z.number().int().positive().default(20).describe("Max number of compensation records to return (default 20)")
+    }),
+    execute: async ({ symbol: symbol2, limit: limit2 = 20 }) => toToolResponse(limitRows(await getFMPClient().company.getExecutiveCompensation(symbol2), limit2))
   }),
   defineTool({
     name: "getStockPeers",
@@ -376,7 +383,7 @@ var financialDefinitions = [
   ),
   statementTool(
     "getFinancialRatios",
-    "Get financial ratios for a company including profitability, liquidity, and efficiency metrics",
+    "Get financial ratios for a company by period: valuation (P/E incl. diluted P/E, PEG, P/B, P/S, P/FCF, EV multiple), profitability margins, liquidity, leverage, efficiency, and per-share metrics",
     "financial ratios",
     (args) => getFMPClient().financial.getFinancialRatios(args)
   ),
@@ -433,7 +440,7 @@ var financialDefinitions = [
   }),
   defineTool({
     name: "getFinancialRatiosTTM",
-    description: "Get current trailing-twelve-month (TTM) financial ratios for a company (margins, returns, liquidity)",
+    description: "Get current trailing-twelve-month (TTM) financial ratios for a company (one snapshot row): valuation (P/E incl. diluted P/E, PEG, P/B, P/S, P/FCF, EV multiple), margins, liquidity, leverage, and per-share metrics",
     inputSchema: z.object({ symbol: symbol("TTM financial ratios") }),
     execute: async ({ symbol: symbol2 }) => toToolResponse(await getFMPClient().financial.getFinancialRatiosTTM({ symbol: symbol2 }))
   }),
@@ -456,29 +463,36 @@ var financialDefinitions = [
 ];
 var dateRangeSchema = z.object({
   from: z.string().optional().nullable().describe("Start date in YYYY-MM-DD format (optional)"),
-  to: z.string().optional().nullable().describe("End date in YYYY-MM-DD format (optional)")
+  to: z.string().optional().nullable().describe("End date in YYYY-MM-DD format (optional)"),
+  limit: z.number().int().positive().default(50).describe("Max number of entries to return (default 50)")
 });
 var calendarDefinitions = [
   defineTool({
     name: "getEarningsCalendar",
-    description: "Get earnings calendar showing upcoming and recent earnings announcements",
+    description: "Get earnings calendar showing upcoming and recent earnings announcements (at most `limit` entries; narrow the date range for full coverage)",
     inputSchema: dateRangeSchema,
-    execute: async ({ from, to }) => toToolResponse(
-      await getFMPClient().calendar.getEarningsCalendar({
-        from: from ?? void 0,
-        to: to ?? void 0
-      })
+    execute: async ({ from, to, limit: limit2 = 50 }) => toToolResponse(
+      limitRows(
+        await getFMPClient().calendar.getEarningsCalendar({
+          from: from ?? void 0,
+          to: to ?? void 0
+        }),
+        limit2
+      )
     )
   }),
   defineTool({
     name: "getEconomicCalendar",
-    description: "Get economic calendar showing upcoming and recent economic events and indicators",
+    description: "Get economic calendar showing upcoming and recent economic events and indicators (at most `limit` entries; narrow the date range for full coverage)",
     inputSchema: dateRangeSchema,
-    execute: async ({ from, to }) => toToolResponse(
-      await getFMPClient().calendar.getEconomicsCalendar({
-        from: from ?? void 0,
-        to: to ?? void 0
-      })
+    execute: async ({ from, to, limit: limit2 = 50 }) => toToolResponse(
+      limitRows(
+        await getFMPClient().calendar.getEconomicsCalendar({
+          from: from ?? void 0,
+          to: to ?? void 0
+        }),
+        limit2
+      )
     )
   })
 ];
@@ -542,17 +556,20 @@ var economicDefinitions = [
 var etfDefinitions = [
   defineTool({
     name: "getETFHoldings",
-    description: "Get ETF holdings for a specific ETF symbol, showing the underlying assets and their weights",
+    description: "Get the largest holdings of an ETF (by portfolio weight), showing the underlying assets and their weights",
     inputSchema: z.object({
       symbol: z.string().min(1, "ETF symbol is required").describe("ETF symbol (e.g., SPY, QQQ, VTI)"),
-      date: z.string().optional().nullable().describe("Date for holdings in YYYY-MM-DD format (optional)")
+      date: z.string().optional().nullable().describe("Date for holdings in YYYY-MM-DD format (optional)"),
+      limit: z.number().int().positive().default(50).describe("Max number of holdings to return, largest weight first (default 50)")
     }),
-    execute: async ({ symbol: symbol2, date }) => {
+    execute: async ({ symbol: symbol2, date, limit: limit2 = 50 }) => {
       const params = { symbol: symbol2 };
       if (date) {
         params.date = date;
       }
-      return toToolResponse(await getFMPClient().etf.getHoldings(params));
+      return toToolResponse(
+        limitRows(await getFMPClient().etf.getHoldings(params), limit2, (a, b) => b.pctVal - a.pctVal)
+      );
     }
   }),
   defineTool({
@@ -578,11 +595,20 @@ var insiderDefinitions = [
 var institutionalDefinitions = [
   defineTool({
     name: "getInstitutionalHolders",
-    description: "Get institutional holders for a specific stock symbol showing which institutions own shares and their holdings",
+    description: "Get the largest institutional holders of a stock (by shares held), showing which institutions own shares and their holdings",
     inputSchema: z.object({
-      symbol: z.string().min(1, "Stock symbol is required").describe("Stock symbol (e.g., AAPL, MSFT, GOOGL)")
+      symbol: z.string().min(1, "Stock symbol is required").describe("Stock symbol (e.g., AAPL, MSFT, GOOGL)"),
+      limit: z.number().int().positive().default(20).describe("Max number of holders to return, largest first (default 20)")
     }),
-    execute: async ({ symbol: symbol2 }) => toToolResponse(await getFMPClient().institutional.getInstitutionalHolders({ symbol: symbol2 }))
+    // FMP returns thousands of holders in no particular order (~1 MB for AAPL),
+    // so sort by shares held and keep the top `limit`.
+    execute: async ({ symbol: symbol2, limit: limit2 = 20 }) => toToolResponse(
+      limitRows(
+        await getFMPClient().institutional.getInstitutionalHolders({ symbol: symbol2 }),
+        limit2,
+        (a, b) => b.shares - a.shares
+      )
+    )
   })
 ];
 var empty = z.object({});
@@ -593,9 +619,11 @@ var snapshotDateSchema = z.object({
 var marketDefinitions = [
   defineTool({
     name: "getMarketPerformance",
-    description: "Get overall market performance data including major indices performance",
-    inputSchema: empty,
-    execute: async () => toToolResponse(await getFMPClient().market.getMarketPerformance())
+    description: "Get overall market performance data including major indices performance (at most `limit` indices)",
+    inputSchema: z.object({
+      limit: z.number().int().positive().default(50).describe("Max number of indices to return (default 50)")
+    }),
+    execute: async ({ limit: limit2 = 50 }) => toToolResponse(limitRows(await getFMPClient().market.getMarketPerformance(), limit2))
   }),
   defineTool({
     name: "getSectorPerformance",
@@ -799,6 +827,7 @@ var technicalDefinitions = [
     }
   })
 ];
+var byNameLimit = z.number().int().positive().default(50).describe("Max number of trades to return (default 50)");
 var symbolSchema3 = z.object({
   symbol: z.string().min(1, "Stock symbol is required").describe("Stock symbol (e.g., AAPL, MSFT, GOOGL)")
 });
@@ -820,19 +849,25 @@ var senateHouseDefinitions = [
   }),
   defineTool({
     name: "getSenateTradingByName",
-    description: "Get senate trading data for a specific senator by name showing their trading activity",
+    description: "Get senate trading data for a specific senator by name showing their trading activity (at most `limit` trades)",
     inputSchema: z.object({
-      name: z.string().min(1, "Name is required").describe("The name of the senator to get trading data for")
+      name: z.string().min(1, "Name is required").describe("The name of the senator to get trading data for"),
+      limit: byNameLimit
     }),
-    execute: async ({ name }) => toToolResponse(await getFMPClient().senateHouse.getSenateTradingByName({ name }))
+    execute: async ({ name, limit: limit2 = 50 }) => toToolResponse(
+      limitRows(await getFMPClient().senateHouse.getSenateTradingByName({ name }), limit2)
+    )
   }),
   defineTool({
     name: "getHouseTradingByName",
-    description: "Get house trading data for a specific representative by name showing their trading activity",
+    description: "Get house trading data for a specific representative by name showing their trading activity (at most `limit` trades)",
     inputSchema: z.object({
-      name: z.string().min(1, "Name is required").describe("The name of the representative to get trading data for")
+      name: z.string().min(1, "Name is required").describe("The name of the representative to get trading data for"),
+      limit: byNameLimit
     }),
-    execute: async ({ name }) => toToolResponse(await getFMPClient().senateHouse.getHouseTradingByName({ name }))
+    execute: async ({ name, limit: limit2 = 50 }) => toToolResponse(
+      limitRows(await getFMPClient().senateHouse.getHouseTradingByName({ name }), limit2)
+    )
   }),
   defineTool({
     name: "getSenateTradingRSSFeed",