README.md•1.95 kB
# Polygon MCP Server
A Model Context Protocol (MCP) server that provides tools for interacting with the Polygon.io API for market data.
## Features
This MCP server provides the following tools:
- **get_ticker_details** - Get details about a ticker symbol
- **get_latest_quote** - Get real-time quote for a ticker
- **get_aggregates** - Get aggregate bars for a ticker
- **get_daily_open_close** - Get daily open/close prices
- **get_market_status** - Check if markets are open
- **get_ticker_news** - Get news articles for a ticker
- **list_tickers** - Search/list available tickers
- **get_snapshot** - Get snapshot of ticker(s)
## Installation
1. Clone this repository
2. Install dependencies:
```bash
npm install
```
3. Build the server:
```bash
npm run build
```
## Configuration
The server requires the following environment variable:
- `POLYGON_API_KEY` - Your Polygon.io API key
### MCP Settings Configuration
Add the following to your MCP settings file:
```json
{
"mcpServers": {
"polygon": {
"command": "node",
"args": ["/path/to/polygon-server/build/index.js"],
"env": {
"POLYGON_API_KEY": "your-api-key"
}
}
}
}
```
## Usage Examples
### Get Market Status
```json
{
"tool": "get_market_status",
"arguments": {}
}
```
### Get Ticker Details
```json
{
"tool": "get_ticker_details",
"arguments": {
"ticker": "AAPL"
}
}
```
### Get Historical Data
```json
{
"tool": "get_aggregates",
"arguments": {
"ticker": "AAPL",
"timespan": "day",
"from": "2024-01-01",
"to": "2024-01-31"
}
}
```
### Get News
```json
{
"tool": "get_ticker_news",
"arguments": {
"ticker": "TSLA",
"limit": 5
}
}
```
## Development
- Run in watch mode: `npm run watch`
- Run tests: `npm test`
- Lint code: `npm run lint`
## API Documentation
For more information about the Polygon.io API, visit: https://polygon.io/docs
## License
MIT