fmp-ai-tools 0.0.3 → 0.0.5

package/README.md

@@ -1,17 +1,17 @@
-# FMP Tools
+# FMP AI Tools
 
-AI tools for Financial Modeling Prep (FMP) Node API - compatible with Vercel AI SDK, Langchain, OpenAI, and more.
+AI tools for Financial Modeling Prep (FMP) Node API - compatible with Vercel AI SDK, OpenAI Agents, and more.
 
 This package provides pre-built AI tools that can be used with various AI frameworks. For direct API access, use the `fmp-node-api` package.
 
 ## Installation
 
 ```bash
-npm install fmp-tools
+npm install fmp-ai-tools
 # or
-pnpm add fmp-tools
+pnpm add fmp-ai-tools
 # or
-yarn add fmp-tools
+yarn add fmp-ai-tools
 ```
 
 ## Quick Start
@@ -21,7 +21,7 @@ yarn add fmp-tools
 ```typescript
 import { openai } from '@ai-sdk/openai';
 import { streamText, convertToModelMessages, stepCountIs } from 'ai';
-import { fmpTools } from 'fmp-tools/vercel-ai';
+import { fmpTools } from 'fmp-ai-tools/vercel-ai';
 
 export async function POST(req: Request) {
   const { messages } = await req.json();
@@ -37,6 +37,29 @@ export async function POST(req: Request) {
 }
 ```
 
+### OpenAI Agents
+
+```typescript
+import { Agent } from '@openai/agents';
+import { fmpTools } from 'fmp-ai-tools/openai';
+
+const agent = new Agent({
+  name: 'Financial Analyst',
+  instructions: 'You are a financial analyst with access to real-time market data.',
+  tools: fmpTools,
+});
+
+const result = await agent.run({
+  messages: [
+    {
+      role: 'user',
+      content:
+        'Get the current stock quote for Apple (AAPL) and show me their latest balance sheet',
+    },
+  ],
+});
+```
+
 ## Configuration
 
 **Important**: You must set your FMP API key as an environment variable for the tools to work:
@@ -112,12 +135,12 @@ The tools internally use the `fmp-node-api` library, which reads this environmen
 
 ## Using Individual Tools
 
-You can import and use specific tool categories or individual tools:
+You can import and use specific tool categories or individual tools from either provider:
 
-### Import Specific Categories
+### Import Specific Categories (Vercel AI)
 
 ```typescript
-import { quoteTools, financialTools, marketTools } from 'fmp-tools/vercel-ai';
+import { quoteTools, financialTools, marketTools } from 'fmp-ai-tools/vercel-ai';
 
 // Use only quote and financial tools
 const selectedTools = {
@@ -133,7 +156,33 @@ const result = streamText({
 });
 ```
 
-### Example Tool Usage
+### Import Specific Categories (OpenAI)
+
+```typescript
+import { quoteTools, financialTools, marketTools } from 'fmp-ai-tools/openai';
+
+// Use only quote and financial tools
+const selectedTools = [...quoteTools, ...financialTools];
+
+// Use with OpenAI Agents
+const agent = new Agent({
+  name: 'Financial Analyst',
+  instructions: 'You are a financial analyst with access to real-time market data.',
+  tools: selectedTools,
+});
+```
+
+### Import Individual Tools
+
+```typescript
+// Vercel AI SDK
+import { getStockQuote, getCompanyProfile } from 'fmp-ai-tools/vercel-ai';
+
+// OpenAI Agents
+import { getStockQuote, getCompanyProfile } from 'fmp-ai-tools/openai';
+```
+
+## Example Tool Usage
 
 Here are some example prompts you can use with the tools:
 

package/dist/providers/openai/index.d.mts

@@ -0,0 +1,56 @@
+import * as _openai_agents from '@openai/agents';
+import { Tool } from '@openai/agents';
+
+declare const getCompanyProfile: _openai_agents.FunctionTool<unknown, undefined, string>;
+
+declare const getEarningsCalendar: _openai_agents.FunctionTool<unknown, undefined, string>;
+declare const getEconomicCalendar: _openai_agents.FunctionTool<unknown, undefined, string>;
+
+declare const getTreasuryRates: _openai_agents.FunctionTool<unknown, undefined, string>;
+declare const getEconomicIndicators: _openai_agents.FunctionTool<unknown, undefined, string>;
+
+declare const getETFHoldings: _openai_agents.FunctionTool<unknown, undefined, string>;
+declare const getETFProfile: _openai_agents.FunctionTool<unknown, undefined, string>;
+
+declare const getBalanceSheet: _openai_agents.FunctionTool<unknown, undefined, string>;
+declare const getIncomeStatement: _openai_agents.FunctionTool<unknown, undefined, string>;
+declare const getCashFlowStatement: _openai_agents.FunctionTool<unknown, undefined, string>;
+declare const getFinancialRatios: _openai_agents.FunctionTool<unknown, undefined, string>;
+
+declare const getInsiderTrading: _openai_agents.FunctionTool<unknown, undefined, string>;
+
+declare const getInstitutionalHolders: _openai_agents.FunctionTool<unknown, undefined, string>;
+
+declare const getMarketPerformance: _openai_agents.FunctionTool<unknown, undefined, string>;
+declare const getSectorPerformance: _openai_agents.FunctionTool<unknown, undefined, string>;
+declare const getGainers: _openai_agents.FunctionTool<unknown, undefined, string>;
+declare const getLosers: _openai_agents.FunctionTool<unknown, undefined, string>;
+declare const getMostActive: _openai_agents.FunctionTool<unknown, undefined, string>;
+
+declare const getStockQuote: _openai_agents.FunctionTool<unknown, undefined, string>;
+
+declare const getSenateTrading: _openai_agents.FunctionTool<unknown, undefined, string>;
+declare const getHouseTrading: _openai_agents.FunctionTool<unknown, undefined, string>;
+declare const getSenateTradingByName: _openai_agents.FunctionTool<unknown, undefined, string>;
+declare const getHouseTradingByName: _openai_agents.FunctionTool<unknown, undefined, string>;
+declare const getSenateTradingRSSFeed: _openai_agents.FunctionTool<unknown, undefined, string>;
+declare const getHouseTradingRSSFeed: _openai_agents.FunctionTool<unknown, undefined, string>;
+
+declare const getMarketCap: _openai_agents.FunctionTool<unknown, undefined, string>;
+declare const getStockSplits: _openai_agents.FunctionTool<unknown, undefined, string>;
+declare const getDividendHistory: _openai_agents.FunctionTool<unknown, undefined, string>;
+
+declare const companyTools: Tool[];
+declare const calendarTools: Tool[];
+declare const economicTools: Tool[];
+declare const etfTools: Tool[];
+declare const financialTools: Tool[];
+declare const insiderTools: Tool[];
+declare const institutionalTools: Tool[];
+declare const marketTools: Tool[];
+declare const quoteTools: Tool[];
+declare const senateHouseTools: Tool[];
+declare const stockTools: Tool[];
+declare const fmpTools: Tool[];
+
+export { calendarTools, companyTools, economicTools, etfTools, financialTools, fmpTools, getBalanceSheet, getCashFlowStatement, getCompanyProfile, getDividendHistory, getETFHoldings, getETFProfile, getEarningsCalendar, getEconomicCalendar, getEconomicIndicators, getFinancialRatios, getGainers, getHouseTrading, getHouseTradingByName, getHouseTradingRSSFeed, getIncomeStatement, getInsiderTrading, getInstitutionalHolders, getLosers, getMarketCap, getMarketPerformance, getMostActive, getSectorPerformance, getSenateTrading, getSenateTradingByName, getSenateTradingRSSFeed, getStockQuote, getStockSplits, getTreasuryRates, insiderTools, institutionalTools, marketTools, quoteTools, senateHouseTools, stockTools };

package/dist/providers/openai/index.d.ts

@@ -0,0 +1,56 @@
+import * as _openai_agents from '@openai/agents';
+import { Tool } from '@openai/agents';
+
+declare const getCompanyProfile: _openai_agents.FunctionTool<unknown, undefined, string>;
+
+declare const getEarningsCalendar: _openai_agents.FunctionTool<unknown, undefined, string>;
+declare const getEconomicCalendar: _openai_agents.FunctionTool<unknown, undefined, string>;
+
+declare const getTreasuryRates: _openai_agents.FunctionTool<unknown, undefined, string>;
+declare const getEconomicIndicators: _openai_agents.FunctionTool<unknown, undefined, string>;
+
+declare const getETFHoldings: _openai_agents.FunctionTool<unknown, undefined, string>;
+declare const getETFProfile: _openai_agents.FunctionTool<unknown, undefined, string>;
+
+declare const getBalanceSheet: _openai_agents.FunctionTool<unknown, undefined, string>;
+declare const getIncomeStatement: _openai_agents.FunctionTool<unknown, undefined, string>;
+declare const getCashFlowStatement: _openai_agents.FunctionTool<unknown, undefined, string>;
+declare const getFinancialRatios: _openai_agents.FunctionTool<unknown, undefined, string>;
+
+declare const getInsiderTrading: _openai_agents.FunctionTool<unknown, undefined, string>;
+
+declare const getInstitutionalHolders: _openai_agents.FunctionTool<unknown, undefined, string>;
+
+declare const getMarketPerformance: _openai_agents.FunctionTool<unknown, undefined, string>;
+declare const getSectorPerformance: _openai_agents.FunctionTool<unknown, undefined, string>;
+declare const getGainers: _openai_agents.FunctionTool<unknown, undefined, string>;
+declare const getLosers: _openai_agents.FunctionTool<unknown, undefined, string>;
+declare const getMostActive: _openai_agents.FunctionTool<unknown, undefined, string>;
+
+declare const getStockQuote: _openai_agents.FunctionTool<unknown, undefined, string>;
+
+declare const getSenateTrading: _openai_agents.FunctionTool<unknown, undefined, string>;
+declare const getHouseTrading: _openai_agents.FunctionTool<unknown, undefined, string>;
+declare const getSenateTradingByName: _openai_agents.FunctionTool<unknown, undefined, string>;
+declare const getHouseTradingByName: _openai_agents.FunctionTool<unknown, undefined, string>;
+declare const getSenateTradingRSSFeed: _openai_agents.FunctionTool<unknown, undefined, string>;
+declare const getHouseTradingRSSFeed: _openai_agents.FunctionTool<unknown, undefined, string>;
+
+declare const getMarketCap: _openai_agents.FunctionTool<unknown, undefined, string>;
+declare const getStockSplits: _openai_agents.FunctionTool<unknown, undefined, string>;
+declare const getDividendHistory: _openai_agents.FunctionTool<unknown, undefined, string>;
+
+declare const companyTools: Tool[];
+declare const calendarTools: Tool[];
+declare const economicTools: Tool[];
+declare const etfTools: Tool[];
+declare const financialTools: Tool[];
+declare const insiderTools: Tool[];
+declare const institutionalTools: Tool[];
+declare const marketTools: Tool[];
+declare const quoteTools: Tool[];
+declare const senateHouseTools: Tool[];
+declare const stockTools: Tool[];
+declare const fmpTools: Tool[];
+
+export { calendarTools, companyTools, economicTools, etfTools, financialTools, fmpTools, getBalanceSheet, getCashFlowStatement, getCompanyProfile, getDividendHistory, getETFHoldings, getETFProfile, getEarningsCalendar, getEconomicCalendar, getEconomicIndicators, getFinancialRatios, getGainers, getHouseTrading, getHouseTradingByName, getHouseTradingRSSFeed, getIncomeStatement, getInsiderTrading, getInstitutionalHolders, getLosers, getMarketCap, getMarketPerformance, getMostActive, getSectorPerformance, getSenateTrading, getSenateTradingByName, getSenateTradingRSSFeed, getStockQuote, getStockSplits, getTreasuryRates, insiderTools, institutionalTools, marketTools, quoteTools, senateHouseTools, stockTools };