stock-market-server

# Stock Market MCP Server A TypeScript-based MCP server for retrieving stock market data. This server provides real-time stock market information and company financial data through the Alpha Vantage API. ## Key Information for Generating the MCPServer - [.clinerules](https://docs.cline.bot/mcp-servers/mcp-server-from-scratch) - [api-key](https://www.alphavantage.co/support/#api-key) ```md 1. Plan mode help me build a stock market mcp server that uses the AlphaVantage public API I want it to have these tools： - generate US market report/briefing - generate financial statement for company - get ticker price for company - any other basic tools you think would be helpful - api key: <your api key> 2. please test all the tools to confirm their functionality ``` ## Features ### Tools - `get_ticker_price` - Get real-time stock price - Requires the stock ticker symbol as a parameter - Returns the latest stock price and timestamp - `get_market_report` - Get the US market report - Provides an overview of the overall market conditions - `get_financial_statement` - Get company financial statements - Supports three types of statements: income (收入), balance (资产负债表), cashflow (现金流量表) - Requires the stock ticker symbol and statement type - `get_company_overview` - Get company overview information - Requires the stock ticker symbol - Returns key metrics and basic information about the company ## Development Environment Setup ### Install Dependencies ```bash npm install ``` ### Build the Project ```bash npm run build ``` ### Development Mode (Automatic Rebuild) ```bash npm run watch ``` ## Installation Instructions To use this server in Claude Desktop, you need to add the server configuration: ### MacOS Configuration file path: `~/Library/Application Support/Claude/claude_desktop_config.json` ### Windows Configuration file path: `%APPDATA%/Claude/claude_desktop_config.json` Configuration example: ```json { "mcpServers": { "stock-market-server": { "command": "/path/to/stock-market-server/build/index.js" } } } ``` ## Debugging Since the MCP server communicates via standard input/output (stdio), debugging can be challenging. It is recommended to use the MCP Inspector tool for debugging: ```bash npm run inspector ``` After running, the Inspector will provide a browser access address, allowing you to use debugging tools through the browser. ## Tech Stack - TypeScript - Node.js - Alpha Vantage API - MCP SDK (@modelcontextprotocol/sdk) ## Notes - Ensure you have a valid Alpha Vantage API key before use - All API responses are returned in JSON format - Be aware of the call frequency limits of the Alpha Vantage API ## License [Add license information]