iflow-mcp_saintdoresh-yfinance-trader 0.1.0__py3-none-any.whl

iflow_mcp_saintdoresh_yfinance_trader-0.1.0.dist-info/METADATA

@@ -0,0 +1,220 @@
+Metadata-Version: 2.4
+Name: iflow-mcp_saintdoresh-yfinance-trader
+Version: 0.1.0
+Summary: YFinance Trader MCP Tool for Claude Desktop
+Author-email: Your Name <your.email@example.com>
+License: MIT
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+Requires-Dist: yfinance>=0.2.36
+Requires-Dist: fastapi>=0.103.1
+Requires-Dist: uvicorn>=0.23.2
+Requires-Dist: pydantic>=2.4.2
+Requires-Dist: requests>=2.31.0
+Requires-Dist: pandas>=2.1.0
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0.0; extra == "dev"
+Requires-Dist: black>=23.1.0; extra == "dev"
+Requires-Dist: isort>=5.12.0; extra == "dev"
+
+# YFinance Trader MCP Tool for Claude Desktop
+
+An MCP (Model Context Protocol) tool that provides stock market data and trading capabilities using the yfinance library, specifically adapted for Claude Desktop.
+
+> **Credit**: This project was inspired by [mcp-stocks](https://github.com/luigiajah/mcp-stocks) by Luigi Ajah, which is a similar implementation for Cursor. This adaptation modifies the original concept to work with Claude Desktop.
+
+## Tutorial
+
+For a detailed guide on setting up and using this tool, check out our Medium tutorial:
+[Tutorial: Using Claude Desktop with YFinance Trader MCP Tool to Access Real-Time Stock Market Data](https://medium.com/@saintdoresh/tutorial-using-claude-desktop-with-yfinance-trader-mcp-tool-to-access-real-time-stock-market-data-904cd1e1ba09)
+
+## Features
+
+- Real-time stock quotes
+- Company information and financial metrics
+- Historical price data
+- Symbol search functionality
+- Analyst recommendations
+- Insider transaction tracking
+
+## Setup
+
+1. Ensure you have Python 3.10 or higher installed
+
+2. Install dependencies:
+```bash
+pip install -r requirements.txt
+```
+
+## Integration with Claude Desktop
+
+1. Configure your MCP settings in Claude Desktop by adding the following to your MCP configuration:
+
+```json
+{
+  "mcpServers": {
+    "yfinance-trader": {
+      "command": "py",
+      "args": ["-3.13", "path/to/your/main.py"]
+    }
+  }
+}
+```
+
+2. Replace the path with the full path to your main.py file
+3. Restart Claude Desktop if needed
+
+## Available Tools
+
+### 1. get_stock_quote
+Get real-time stock quote information:
+```json
+{
+    "symbol": "AAPL",
+    "price": 150.25,
+    "change": 2.5,
+    "changePercent": 1.67,
+    "volume": 1234567,
+    "timestamp": "2024-03-20T10:30:00"
+}
+```
+
+### 2. get_company_overview
+Get company information and key metrics:
+```json
+{
+    "name": "Apple Inc.",
+    "sector": "Technology",
+    "industry": "Consumer Electronics",
+    "marketCap": 2500000000000,
+    "peRatio": 25.4,
+    "forwardPE": 24.2,
+    "dividendYield": 0.65,
+    "52WeekHigh": 182.94,
+    "52WeekLow": 124.17
+}
+```
+
+### 3. get_time_series_daily
+Get historical daily price data:
+```json
+{
+    "symbol": "AAPL",
+    "timeSeriesDaily": [
+        {
+            "date": "2024-03-20T00:00:00",
+            "open": 150.25,
+            "high": 152.30,
+            "low": 149.80,
+            "close": 151.75,
+            "volume": 12345678
+        }
+        // ... more data points
+    ]
+}
+```
+
+### 4. search_symbol
+Search for stocks and other securities:
+```json
+{
+    "results": [
+        {
+            "symbol": "AAPL",
+            "name": "Apple Inc.",
+            "type": "EQUITY",
+            "exchange": "NASDAQ"
+        }
+        // ... more results
+    ]
+}
+```
+
+### 5. get_recommendations
+Get analyst recommendations for a stock:
+```json
+{
+    "symbol": "AAPL",
+    "recommendations": [
+        {
+            "period": "2024-03-15T00:00:00",
+            "strongBuy": 15,
+            "buy": 20,
+            "hold": 8,
+            "sell": 2,
+            "strongSell": 0
+        }
+        // ... more periods
+    ]
+}
+```
+
+### 6. get_insider_transactions
+Get insider trading information:
+```json
+{
+    "symbol": "AAPL",
+    "transactions": [
+        {
+            "date": "2024-03-15T00:00:00",
+            "insider": "John Doe",
+            "position": "Director",
+            "transactionType": "Buy",
+            "shares": 1000,
+            "value": 150250.00,
+            "url": "https://finance.yahoo.com/...",
+            "text": "Purchase of 1000 shares",
+            "startDate": "2024-03-15",
+            "ownership": "Direct"
+        }
+        // ... more transactions
+    ]
+}
+```
+
+## Sample Queries
+
+You can ask Claude Desktop questions like:
+- "What is the current stock price and daily change for AAPL?"
+- "Can you give me a company overview for Microsoft (MSFT)?"
+- "Show me the historical price data for Tesla (TSLA) over the last 3 months."
+- "Search for stocks related to 'NVDA'."
+- "What are the analyst recommendations for Amazon (AMZN)?"
+- "Have there been any recent insider transactions for Google (GOOGL)?"
+
+## Cryptocurrency Support
+
+Limited cryptocurrency data is available using special ticker formats:
+- BTC-USD for Bitcoin
+- ETH-USD for Ethereum
+- DOGE-USD for Dogecoin
+
+## Error Handling
+
+All tools include proper error handling and will return an error message if something goes wrong:
+```json
+{
+    "error": "Failed to fetch quote for INVALID_SYMBOL"
+}
+```
+
+## Troubleshooting
+
+If the MCP server is not working in Claude Desktop:
+1. Make sure the server is running - you should see output when you start the script
+2. Verify the path in your settings is correct and absolute
+3. Make sure Python 3.10+ is in your system PATH
+4. Check that all dependencies are installed
+5. Try restarting Claude Desktop
+6. Check logs for any error messages
+
+## Differences from the original mcp-stocks project
+
+- Uses the MCP library directly instead of FastAPI
+- Adapted for Claude Desktop instead of Cursor
+- Modified error handling and response formats
+- Updated configuration approach
+
+## License
+
+MIT License

iflow_mcp_saintdoresh_yfinance_trader-0.1.0.dist-info/RECORD

@@ -0,0 +1,6 @@
+main.py,sha256=zSa9WZmI8ABNBFZc6ooKv97egLnKcPJIWSuzN4sc5lA,7538
+iflow_mcp_saintdoresh_yfinance_trader-0.1.0.dist-info/METADATA,sha256=n0bwHyFqopcGDKQKv03ApVIW2-CJF8llwi526fX6MyQ,5685
+iflow_mcp_saintdoresh_yfinance_trader-0.1.0.dist-info/WHEEL,sha256=wUyA8OaulRlbfwMtmQsvNngGrxQHAvkKcvRmdizlJi0,92
+iflow_mcp_saintdoresh_yfinance_trader-0.1.0.dist-info/entry_points.txt,sha256=BZv3T9vMtq-5MmLxZXR31RMpDtC2NLxUNwfOCVbSbZo,46
+iflow_mcp_saintdoresh_yfinance_trader-0.1.0.dist-info/top_level.txt,sha256=ZAMgPdWghn6xTRBO6Kc3ML1y3ZrZLnjZlqbboKXc_AE,5
+iflow_mcp_saintdoresh_yfinance_trader-0.1.0.dist-info/RECORD,,

iflow_mcp_saintdoresh_yfinance_trader-0.1.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (80.10.2)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

iflow_mcp_saintdoresh_yfinance_trader-0.1.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+yfinance-trader = main:main

iflow_mcp_saintdoresh_yfinance_trader-0.1.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+main

main.py

@@ -0,0 +1,224 @@
+from typing import Any, Dict, List
+import yfinance as yf
+from datetime import datetime, timedelta
+from mcp.server.fastmcp import FastMCP
+import asyncio
+import logging
+
+# Configure logging
+logging.basicConfig(level=logging.INFO)
+logger = logging.getLogger(__name__)
+
+# Initialize FastMCP server
+mcp = FastMCP("yfinance-trader")
+
+@mcp.tool("get_stock_quote")
+async def get_stock_quote(symbol: str) -> Dict[str, Any]:
+    """Get real-time stock quote information.
+
+    Args:
+        symbol (str): Stock symbol (e.g., AAPL, MSFT, GOOGL)
+
+    Returns:
+        Dict containing current stock price and related information
+    """
+    try:
+        stock = yf.Ticker(symbol)
+        info = stock.info
+        return {
+            "symbol": symbol,
+            "price": info.get("regularMarketPrice", 0),
+            "change": info.get("regularMarketChange", 0),
+            "changePercent": info.get("regularMarketChangePercent", 0),
+            "volume": info.get("regularMarketVolume", 0),
+            "timestamp": datetime.now().isoformat()
+        }
+    except Exception as e:
+        logger.error(f"Error fetching quote for {symbol}: {str(e)}")
+        return {"error": f"Failed to fetch quote for {symbol}"}
+
+@mcp.tool("get_company_overview")
+async def get_company_overview(symbol: str) -> Dict[str, Any]:
+    """Get company information, financial ratios, and other key metrics.
+
+    Args:
+        symbol (str): Stock symbol (e.g., AAPL, MSFT, GOOGL)
+
+    Returns:
+        Dict containing company information and key metrics
+    """
+    try:
+        stock = yf.Ticker(symbol)
+        info = stock.info
+        return {
+            "name": info.get("longName", ""),
+            "sector": info.get("sector", ""),
+            "industry": info.get("industry", ""),
+            "marketCap": info.get("marketCap", 0),
+            "peRatio": info.get("trailingPE", 0),
+            "forwardPE": info.get("forwardPE", 0),
+            "dividendYield": info.get("dividendYield", 0),
+            "52WeekHigh": info.get("fiftyTwoWeekHigh", 0),
+            "52WeekLow": info.get("fiftyTwoWeekLow", 0)
+        }
+    except Exception as e:
+        logger.error(f"Error fetching company overview for {symbol}: {str(e)}")
+        return {"error": f"Failed to fetch company overview for {symbol}"}
+
+@mcp.tool("get_time_series_daily")
+async def get_time_series_daily(symbol: str, outputsize: str = "compact") -> Dict[str, Any]:
+    """Get daily time series stock data.
+
+    Args:
+        symbol (str): Stock symbol (e.g., AAPL, MSFT, GOOGL)
+        outputsize (str): Output size: 'compact' (latest 100 data points) or 'full' (up to 20 years of data)
+
+    Returns:
+        Dict containing historical daily price data
+    """
+    try:
+        stock = yf.Ticker(symbol)
+        period = "3mo" if outputsize == "compact" else "max"
+        history = stock.history(period=period)
+
+        data = []
+        for date, row in history.iterrows():
+            data.append({
+                "date": date.isoformat(),
+                "open": row["Open"],
+                "high": row["High"],
+                "low": row["Low"],
+                "close": row["Close"],
+                "volume": row["Volume"]
+            })
+
+        return {
+            "symbol": symbol,
+            "timeSeriesDaily": data
+        }
+    except Exception as e:
+        logger.error(f"Error fetching time series for {symbol}: {str(e)}")
+        return {"error": f"Failed to fetch time series for {symbol}"}
+
+@mcp.tool("search_symbol")
+async def search_symbol(keywords: str) -> Dict[str, Any]:
+    """Search for stocks, ETFs, mutual funds, or other securities.
+
+    Args:
+        keywords (str): Keywords to search for (e.g., apple, microsoft, tech)
+
+    Returns:
+        Dict containing search results
+    """
+    try:
+        tickers = yf.Tickers(keywords)
+        results = []
+
+        for symbol in keywords.split():
+            try:
+                info = tickers.tickers[symbol].info
+                results.append({
+                    "symbol": symbol,
+                    "name": info.get("longName", ""),
+                    "type": info.get("quoteType", ""),
+                    "exchange": info.get("exchange", "")
+                })
+            except:
+                continue
+
+        return {"results": results}
+    except Exception as e:
+        logger.error(f"Error searching for {keywords}: {str(e)}")
+        return {"error": f"Failed to search for {keywords}"}
+
+@mcp.tool("get_recommendations")
+async def get_recommendations(symbol: str) -> Dict[str, Any]:
+    """Get analyst recommendations for a stock.
+
+    Args:
+        symbol (str): Stock symbol (e.g., AAPL, MSFT, GOOGL)
+
+    Returns:
+        Dict containing analyst recommendations including strongBuy, buy, hold, sell, strongSell counts
+    """
+    try:
+        stock = yf.Ticker(symbol)
+        recommendations = stock.recommendations
+
+        if recommendations is None or recommendations.empty:
+            return {
+                "symbol": symbol,
+                "recommendations": []
+            }
+
+        # Convert the recommendations DataFrame to a list of dictionaries
+        recs = []
+        for index, row in recommendations.iterrows():
+            rec_data = {
+                "period": index.isoformat() if hasattr(index, "isoformat") else str(index),
+                "strongBuy": int(row.get("strongBuy", 0)),
+                "buy": int(row.get("buy", 0)),
+                "hold": int(row.get("hold", 0)),
+                "sell": int(row.get("sell", 0)),
+                "strongSell": int(row.get("strongSell", 0))
+            }
+            recs.append(rec_data)
+
+        return {
+            "symbol": symbol,
+            "recommendations": recs
+        }
+    except Exception as e:
+        logger.error(f"Error fetching recommendations for {symbol}: {str(e)}")
+        return {"error": f"Failed to fetch recommendations for {symbol}"}
+
+@mcp.tool("get_insider_transactions")
+async def get_insider_transactions(symbol: str) -> Dict[str, Any]:
+    """Get insider transactions for a company.
+
+    Args:
+        symbol (str): Stock symbol (e.g., AAPL, MSFT, GOOGL)
+
+    Returns:
+        Dict containing recent insider transactions
+    """
+    try:
+        stock = yf.Ticker(symbol)
+        insider = stock.insider_transactions
+
+        if insider is None or insider.empty:
+            return {
+                "symbol": symbol,
+                "transactions": []
+            }
+
+        transactions = []
+        for index, row in insider.iterrows():
+            transaction = {
+                "date": index.isoformat() if hasattr(index, "isoformat") else str(index),
+                "insider": row.get("Insider", ""),
+                "position": row.get("Position", ""),
+                "transactionType": row.get("Transaction", ""),
+                "shares": int(row.get("Shares", 0)),
+                "value": float(row.get("Value", 0)),
+                "url": row.get("URL", ""),
+                "text": row.get("Text", ""),
+                "startDate": row.get("Start Date", ""),
+                "ownership": row.get("Ownership", "")
+            }
+            transactions.append(transaction)
+
+        return {
+            "symbol": symbol,
+            "transactions": transactions
+        }
+    except Exception as e:
+        logger.error(f"Error fetching insider transactions for {symbol}: {str(e)}")
+        return {"error": f"Failed to fetch insider transactions for {symbol}"}
+
+def main():
+    """Main entry point for the MCP server."""
+    mcp.run()
+
+if __name__ == "__main__":
+    main()