fmp-ai-tools 0.0.4 → 0.0.6

package/README.md

@@ -1,6 +1,6 @@
 # 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.
 
@@ -14,6 +14,18 @@ pnpm add fmp-ai-tools
 yarn add fmp-ai-tools
 ```
 
+## Version Compatibility
+
+### OpenAI Agents Compatibility
+
+**⚠️ Important**: This package requires `@openai/agents` version `^0.0.17` or higher due to breaking changes in the API.
+
+If you're using an older version, you'll encounter errors like:
+
+```
+Zod field uses .optional() without .nullable() which is not supported by the API
+```
+
 ## Quick Start
 
 ### Vercel AI SDK (Recommended)
@@ -37,6 +49,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:
@@ -47,6 +82,45 @@ FMP_API_KEY=your_api_key_here
 
 The tools internally use the `fmp-node-api` library, which reads this environment variable to authenticate with the Financial Modeling Prep API.
 
+### Debugging and Logging
+
+**⚠️ Development Only**: These logging features are intended for debugging and development, not production use.
+
+Two logging modes controlled by environment variables:
+
+#### Full Logging Mode
+
+```bash
+FMP_TOOLS_LOG_API_RESULTS=true
+```
+
+Logs: tool name, input parameters, result summary with token count, execution time.
+
+#### Data-Only Logging Mode
+
+```bash
+FMP_TOOLS_LOG_DATA_ONLY=true
+```
+
+Logs: result summary and formatted JSON response data.
+
+#### Example Output
+
+**Full Logging:**
+
+```
+🔧 getStockQuote: object (~28 tokens)
+⏱️ Execution Time: 245ms
+```
+
+**Data-Only Logging:**
+
+```
+📤 Result: { "symbol": "AAPL", "price": 150.25, ... }
+```
+
+**Note**: Both modes are disabled by default. Use only during development.
+
 ## Available Tools
 
 ### Quote Tools
@@ -112,9 +186,9 @@ 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-ai-tools/vercel-ai';
@@ -133,7 +207,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, any, string>;
+
+declare const getEarningsCalendar: _openai_agents.FunctionTool<unknown, any, string>;
+declare const getEconomicCalendar: _openai_agents.FunctionTool<unknown, any, string>;
+
+declare const getTreasuryRates: _openai_agents.FunctionTool<unknown, any, string>;
+declare const getEconomicIndicators: _openai_agents.FunctionTool<unknown, any, string>;
+
+declare const getETFHoldings: _openai_agents.FunctionTool<unknown, any, string>;
+declare const getETFProfile: _openai_agents.FunctionTool<unknown, any, string>;
+
+declare const getBalanceSheet: _openai_agents.FunctionTool<unknown, any, string>;
+declare const getIncomeStatement: _openai_agents.FunctionTool<unknown, any, string>;
+declare const getCashFlowStatement: _openai_agents.FunctionTool<unknown, any, string>;
+declare const getFinancialRatios: _openai_agents.FunctionTool<unknown, any, string>;
+
+declare const getInsiderTrading: _openai_agents.FunctionTool<unknown, any, string>;
+
+declare const getInstitutionalHolders: _openai_agents.FunctionTool<unknown, any, string>;
+
+declare const getMarketPerformance: _openai_agents.FunctionTool<unknown, any, string>;
+declare const getSectorPerformance: _openai_agents.FunctionTool<unknown, any, string>;
+declare const getGainers: _openai_agents.FunctionTool<unknown, any, string>;
+declare const getLosers: _openai_agents.FunctionTool<unknown, any, string>;
+declare const getMostActive: _openai_agents.FunctionTool<unknown, any, string>;
+
+declare const getStockQuote: _openai_agents.FunctionTool<unknown, any, string>;
+
+declare const getSenateTrading: _openai_agents.FunctionTool<unknown, any, string>;
+declare const getHouseTrading: _openai_agents.FunctionTool<unknown, any, string>;
+declare const getSenateTradingByName: _openai_agents.FunctionTool<unknown, any, string>;
+declare const getHouseTradingByName: _openai_agents.FunctionTool<unknown, any, string>;
+declare const getSenateTradingRSSFeed: _openai_agents.FunctionTool<unknown, any, string>;
+declare const getHouseTradingRSSFeed: _openai_agents.FunctionTool<unknown, any, string>;
+
+declare const getMarketCap: _openai_agents.FunctionTool<unknown, any, string>;
+declare const getStockSplits: _openai_agents.FunctionTool<unknown, any, string>;
+declare const getDividendHistory: _openai_agents.FunctionTool<unknown, any, string>;
+
+declare const companyTools: Tool<unknown>[];
+declare const calendarTools: Tool<unknown>[];
+declare const economicTools: Tool<unknown>[];
+declare const etfTools: Tool<unknown>[];
+declare const financialTools: Tool<unknown>[];
+declare const insiderTools: Tool<unknown>[];
+declare const institutionalTools: Tool<unknown>[];
+declare const marketTools: Tool<unknown>[];
+declare const quoteTools: Tool<unknown>[];
+declare const senateHouseTools: Tool<unknown>[];
+declare const stockTools: Tool<unknown>[];
+declare const fmpTools: Tool<unknown>[];
+
+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, any, string>;
+
+declare const getEarningsCalendar: _openai_agents.FunctionTool<unknown, any, string>;
+declare const getEconomicCalendar: _openai_agents.FunctionTool<unknown, any, string>;
+
+declare const getTreasuryRates: _openai_agents.FunctionTool<unknown, any, string>;
+declare const getEconomicIndicators: _openai_agents.FunctionTool<unknown, any, string>;
+
+declare const getETFHoldings: _openai_agents.FunctionTool<unknown, any, string>;
+declare const getETFProfile: _openai_agents.FunctionTool<unknown, any, string>;
+
+declare const getBalanceSheet: _openai_agents.FunctionTool<unknown, any, string>;
+declare const getIncomeStatement: _openai_agents.FunctionTool<unknown, any, string>;
+declare const getCashFlowStatement: _openai_agents.FunctionTool<unknown, any, string>;
+declare const getFinancialRatios: _openai_agents.FunctionTool<unknown, any, string>;
+
+declare const getInsiderTrading: _openai_agents.FunctionTool<unknown, any, string>;
+
+declare const getInstitutionalHolders: _openai_agents.FunctionTool<unknown, any, string>;
+
+declare const getMarketPerformance: _openai_agents.FunctionTool<unknown, any, string>;
+declare const getSectorPerformance: _openai_agents.FunctionTool<unknown, any, string>;
+declare const getGainers: _openai_agents.FunctionTool<unknown, any, string>;
+declare const getLosers: _openai_agents.FunctionTool<unknown, any, string>;
+declare const getMostActive: _openai_agents.FunctionTool<unknown, any, string>;
+
+declare const getStockQuote: _openai_agents.FunctionTool<unknown, any, string>;
+
+declare const getSenateTrading: _openai_agents.FunctionTool<unknown, any, string>;
+declare const getHouseTrading: _openai_agents.FunctionTool<unknown, any, string>;
+declare const getSenateTradingByName: _openai_agents.FunctionTool<unknown, any, string>;
+declare const getHouseTradingByName: _openai_agents.FunctionTool<unknown, any, string>;
+declare const getSenateTradingRSSFeed: _openai_agents.FunctionTool<unknown, any, string>;
+declare const getHouseTradingRSSFeed: _openai_agents.FunctionTool<unknown, any, string>;
+
+declare const getMarketCap: _openai_agents.FunctionTool<unknown, any, string>;
+declare const getStockSplits: _openai_agents.FunctionTool<unknown, any, string>;
+declare const getDividendHistory: _openai_agents.FunctionTool<unknown, any, string>;
+
+declare const companyTools: Tool<unknown>[];
+declare const calendarTools: Tool<unknown>[];
+declare const economicTools: Tool<unknown>[];
+declare const etfTools: Tool<unknown>[];
+declare const financialTools: Tool<unknown>[];
+declare const insiderTools: Tool<unknown>[];
+declare const institutionalTools: Tool<unknown>[];
+declare const marketTools: Tool<unknown>[];
+declare const quoteTools: Tool<unknown>[];
+declare const senateHouseTools: Tool<unknown>[];
+declare const stockTools: Tool<unknown>[];
+declare const fmpTools: Tool<unknown>[];
+
+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 };