1
- # mcp-polygon MCP server
1
+ # mcp_polygon MCP server
2
2
3
- A MCP server project
3
+ A MCP server project that provides access to Polygon.io financial market data through the MCP protocol.
4
4
5
5
## Components
6
6
@@ -19,14 +19,45 @@ The server provides a single prompt:
19
19
20
20
### Tools
21
21
22
- The server implements one tool:
23
- - add-note: Adds a new note to the server
24
- - Takes "name" and "content" as required string arguments
25
- - Updates server state and notifies clients of resource changes
22
+ The server implements the following tools:
23
+
24
+ 1 . Note Management:
25
+ - add-note: Adds a new note to the server
26
+ - Takes "name" and "content" as required string arguments
27
+ - Updates server state and notifies clients of resource changes
28
+
29
+ 2 . Polygon.io Financial Data:
30
+ - get-aggs: Gets aggregated stock data for a time period
31
+ - Required parameters:
32
+ - ticker: Stock ticker symbol (e.g., AAPL)
33
+ - from_date: Start date in YYYY-MM-DD format
34
+ - to_date: End date in YYYY-MM-DD format
35
+ - Optional parameters:
36
+ - multiplier: Size of the timespan multiplier (default: 1)
37
+ - timespan: Size of the time window (minute, hour, day, week, month, quarter, year) (default: day)
38
+ - limit: Number of results to return (default: 10)
39
+
40
+ - get-trades: Gets historical trade data for a ticker on a specific date
41
+ - Required parameters:
42
+ - ticker: Stock ticker symbol (e.g., AAPL)
43
+ - date: Date for trades in YYYY-MM-DD format
44
+ - Optional parameters:
45
+ - timestamp: Timestamp in Unix milliseconds format (default: 0)
46
+ - limit: Number of results to return (default: 10)
26
47
27
48
## Configuration
28
49
29
- [ TODO: Add configuration details specific to your implementation]
50
+ ### Environment Variables
51
+
52
+ The following environment variables must be set for the server to function properly:
53
+
54
+ - ` POLYGON_API_KEY ` : Your Polygon.io API key
55
+
56
+ You can set this environment variable before running the server:
57
+
58
+ ``` bash
59
+ export POLYGON_API_KEY=" your_polygon_api_key_here"
60
+ ```
30
61
31
62
## Quickstart
32
63
@@ -41,13 +72,13 @@ On Windows: `%APPDATA%/Claude/claude_desktop_config.json`
41
72
<summary >Development/Unpublished Servers Configuration</summary >
42
73
```
43
74
"mcpServers": {
44
- "mcp-polygon ": {
75
+ "mcp_polygon ": {
45
76
"command": "uv",
46
77
"args": [
47
78
"--directory",
48
- "/path/to/mcp-polygon ",
79
+ "/path/to/mcp_polygon ",
49
80
"run",
50
- "mcp-polygon "
81
+ "mcp_polygon "
51
82
]
52
83
}
53
84
}
@@ -58,10 +89,10 @@ On Windows: `%APPDATA%/Claude/claude_desktop_config.json`
58
89
<summary >Published Servers Configuration</summary >
59
90
```
60
91
"mcpServers": {
61
- "mcp-polygon ": {
92
+ "mcp_polygon ": {
62
93
"command": "uvx",
63
94
"args": [
64
- "mcp-polygon "
95
+ "mcp_polygon "
65
96
]
66
97
}
67
98
}
@@ -104,7 +135,7 @@ experience, we strongly recommend using the [MCP Inspector](https://github.com/m
104
135
You can launch the MCP Inspector via [ ` npm ` ] ( https://docs.npmjs.com/downloading-and-installing-node-js-and-npm ) with this command:
105
136
106
137
``` bash
107
- npx @modelcontextprotocol/inspector uv --directory /path/to/mcp-polygon run mcp-polygon
138
+ npx @modelcontextprotocol/inspector uv --directory /path/to/mcp_polygon run mcp_polygon
108
139
```
109
140
110
141
0 commit comments