Skip to content

Update README with Docker usage #12

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update README with Docker usage #12

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -134,6 +134,25 @@ uv sync
POLYGON_API_KEY=your_api_key_here uv run mcp_polygon
```

### Running with Docker

You can also run the MCP server using Docker. The repository provides a
`Dockerfile` and a `docker-compose.yml` to simplify setup.

1. Build the Docker image:

```bash
docker compose build
```

2. Start the container, passing in your API key:

```bash
POLYGON_API_KEY=your_api_key_here docker compose up
Copy link
Preview

Copilot AI May 28, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[nitpick] Consider clarifying that 'docker compose' requires Docker Compose v2 or later; if support for older versions is needed, add a note or alternative command.

Copilot uses AI. Check for mistakes.

```

This starts the server inside a container named `mcp_polygon_server`.

<details>
<summary>Local Dev Config for claude_desktop_config.json</summary>

Expand Down