What is yfinance-mcp-server?
The yfinance-mcp-server is an unofficial Message Control Protocol (MCP) server that provides access to Yahoo Finance stock data, allowing users to retrieve historical stock market data easily.
How to use yfinance-mcp-server?
To use the yfinance-mcp-server, you can set it up with an MCP client by specifying the command to run the server. For example, you can use the command npx onori/yfinance-mcp-server in your MCP client configuration.
Key features of yfinance-mcp-server?
- Retrieve historical stock data with customizable periods and intervals.
- Simple integration with any MCP client.
- Built with TypeScript for enhanced type safety and developer experience.
Use cases of yfinance-mcp-server?
- Fetching historical stock data for analysis and reporting.
- Integrating stock data retrieval into financial applications.
- Supporting educational projects that require real-time stock data.
FAQ from yfinance-mcp-server?
- Is yfinance-mcp-server an official Yahoo Finance product?
No, it is an unofficial server created for accessing Yahoo Finance data.
- What programming language is yfinance-mcp-server built with?
It is built with TypeScript.
- Can I contribute to the yfinance-mcp-server project?
Yes, contributions are welcome, and you can submit a Pull Request.
yfinance-mcp-server
Important Note: This is an unofficial MCP server.
A Message Control Protocol (MCP) server for accessing Yahoo Finance data. This server provides a simple interface to retrieve stock market data through yfinance.
Features
- Get historical stock data with customizable periods and intervals
- Easy to use with any MCP client
- Built with TypeScript for type safety and better developer experience
Usage
Example Cursor MCP Client.
{
"mcpServers": {
"yfinance": {
"command": "npx",
"args": [
"@onori/yfinance-mcp-server"
]
}
}
}
getStockHistory
Retrieves historical stock data for a given symbol.
Parameters:
symbol(required): The stock symbol (e.g., "AAPL" for Apple Inc.)period(required): Time period to fetch data for (e.g., "1d", "5d", "1mo", "3mo", "6mo", "1y", "2y", "5y", "10y", "ytd", "max")interval(optional): Data interval ("1d", "1wk", "1mo")
Example MCP request:
> (Request)
Please use the `getStockHistory` tool to fetch the daily stock data for AAPL for the past week (`period`='1w', `interval`='1d'). Then, render the results as a markdown table.
> (Response Example)
I'll help you fetch Apple's stock data and format it nicely as a markdown table.
First, I'll call the getStockHistory tool to fetch the data:
Let me format this data into a more readable markdown table:
| Date | Open | High | Low | Close | Volume |
|------|------|------|-----|-------|---------|
| Mar 31, 2025 | $217.01 | $225.62 | $216.23 | $222.13 | 65.30M |
| Apr 1, 2025 | $219.81 | $223.68 | $218.90 | $223.19 | 36.41M |
| Apr 2, 2025 | $221.32 | $225.19 | $221.02 | $223.89 | 35.91M |
| Apr 3, 2025 | $205.54 | $207.49 | $201.25 | $203.19 | 103.42M |
| Apr 4, 2025 | $193.89 | $199.88 | $187.34 | $188.38 | 125.57M |
Some notable observations from this data:
- The stock showed significant volatility over this period
- There was a sharp decline in the last two trading days
- Trading volume increased substantially during the declining days, with the highest volume (125.57M shares) on April 4th
- The stock price range was from a high of $225.62 to a low of $187.34 during this period
Would you like any specific analysis of this data or would you like to see different metrics?
Development
To set up the development environment:
- Clone the repository
- Install dependencies:
npm install
- Start the development server:
npm run dev
Contributing
Contributions are welcome! Please feel free to submit a Pull Request.
License
ISC License (ISC)