Skip to content

Commit f7501f7

Browse files
committed
docs: polish readme
1 parent 985b3ab commit f7501f7

File tree

3 files changed

+74
-27
lines changed

3 files changed

+74
-27
lines changed

README.md

Lines changed: 74 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,17 @@
1+
<a href="https://polygon.io">
2+
<div align="center">
3+
<picture>
4+
<source media="(prefers-color-scheme: light)" srcset="assets/polygon_banner_lightmode.png">
5+
<source media="(prefers-color-scheme: dark)" srcset="assets/polygon_banner_darkmode.png">
6+
<img alt="Polygon.io logo" src="assets/polygon_banner_lightmode.png" height="100">
7+
</picture>
8+
</div>
9+
</a>
10+
<br>
11+
12+
> [!IMPORTANT]
13+
> :test_tube: This project is experimental and could be subject to breaking changes.
14+
115
# Polygon.io MCP Server
216

317
A [Model Context Protocol (MCP)](https://modelcontextprotocol.io/) server that provides access to [Polygon.io](https://polygon.io) financial market data API through an LLM-friendly interface.
@@ -19,26 +33,57 @@ This server exposes all Polygon.io API endpoints as MCP tools, providing access
1933
### Prerequisites
2034

2135
- Python 3.8+
22-
- A Polygon.io API key ([Get one here](https://polygon.io))
36+
- A Polygon.io API key
37+
<br/>
38+
[![Button]][Link]
39+
- [Astral UV](https://docs.astral.sh/uv/getting-started/installation/)
40+
- For existing installs, check that you have a version that supports the `uvx` command.
2341

24-
### Direct Installation
42+
### Claude Code
2543

26-
```bash
27-
# Install dependencies
28-
uv sync
29-
30-
# Run the server
31-
POLYGON_API_KEY=your_api_key_here uv run mcp_polygon
32-
```
33-
34-
### Integration with Claude
35-
36-
For Claude users, you can add the Polygon MCP server:
44+
Use the following command to add the Polygon MCP server to your local environment.
3745

3846
```bash
3947
# Claude CLI
4048
claude mcp add polygon -e POLYGON_API_KEY=your_api_key_here -- uv run /path/to/mcp_polygon/entrypoint.py
4149
```
50+
This command will install the MCP server in your current project.
51+
If you want to install it globally, you can run the command with `-s <scope>` flag.
52+
See `claude mcp add --help` for more options.
53+
54+
You can also run `claude mcp add-from-claude-desktop` if the MCP server is installed already for Claude Desktop.
55+
56+
### Claude Desktop
57+
58+
1. Follow the [Claude Desktop MCP installation instructions](https://modelcontextprotocol.io/quickstart/user) to complete the initial installation and find your configuration file.
59+
1. Use the following example as reference to add Polygon's MCP server.
60+
Make sure you complete the various fields.
61+
1. Path find your path to `uvx`, run `which uvx` in your terminal.
62+
2. Replace `<your_api_key_here>` with your actual Polygon.io API key.
63+
3. Replace `<your_home_directory>` with your home directory path, e.g., `/home/username` (Mac/Linux) or `C:\Users\username` (Windows).
64+
65+
<details>
66+
<summary>claude_desktop_config.json</summary>
67+
68+
```json
69+
{
70+
"mcpServers": {
71+
"polygon": {
72+
"command": "<path_to_your_uvx_install>/uvx",
73+
"args": [
74+
"--from",
75+
"git+https://github.com/polygon-io/mcp_polygon@master",
76+
"mcp_polygon"
77+
],
78+
"env": {
79+
"POLYGON_API_KEY": "<your_api_key_here>",
80+
"HOME": "<your_home_directory>"
81+
}
82+
}
83+
}
84+
}
85+
```
86+
</details>
4287

4388
## Usage Examples
4489

@@ -66,22 +111,18 @@ This MCP server implements all Polygon.io API endpoints as tools, including:
66111

67112
Each tool follows the Polygon.io SDK parameter structure while converting responses to standard JSON that LLMs can easily process.
68113

69-
## Configuration
70-
71-
### Environment Variables
72-
73-
- `POLYGON_API_KEY` (required): Your Polygon.io API key
74-
75114
## Development
76115

77-
### Building and Publishing
116+
### Running Locally
117+
118+
Check to ensure you have the [Prerequisites](#prerequisites) installed.
78119

79120
```bash
80121
# Sync dependencies
81122
uv sync
82123

83-
# Build package distributions
84-
uv build
124+
# Run the server
125+
POLYGON_API_KEY=your_api_key_here uv run mcp_polygon
85126
```
86127

87128
### Debugging
@@ -94,12 +135,18 @@ npx @modelcontextprotocol/inspector uv --directory /path/to/mcp_polygon run mcp_
94135

95136
This will launch a browser interface where you can interact with your MCP server directly and see input/output for each tool.
96137

97-
## License
98-
99-
[License information]
100-
101138
## Links
102-
103139
- [Polygon.io Documentation](https://polygon.io/docs)
104140
- [Model Context Protocol](https://modelcontextprotocol.io)
105141
- [MCP Python SDK](https://github.com/modelcontextprotocol/python-sdk)
142+
143+
## Contributing
144+
If you found a bug or have an idea for a new feature, please first discuss it with us by submitting a new issue.
145+
We will respond to issues within at most 3 weeks.
146+
We're also open to volunteers if you want to submit a PR for any open issues but please discuss it with us beforehand.
147+
PRs that aren't linked to an existing issue or discussed with us ahead of time will generally be declined.
148+
149+
<!----------------------------------------------------------------------------->
150+
[Link]: https://polygon.io 'Polygon.io Home Page'
151+
<!---------------------------------[ Buttons ]--------------------------------->
152+
[Button]: https://img.shields.io/badge/Get_One_For_Free-5F5CFF?style=for-the-badge&logoColor=white

assets/polygon_banner_darkmode.png

14.7 KB
Loading

assets/polygon_banner_lightmode.png

15.7 KB
Loading

0 commit comments

Comments
 (0)