Skip to content

Commit 0bd2ac8

Browse files
authored
Update README.md
1 parent a74086e commit 0bd2ac8

File tree

1 file changed

+26
-23
lines changed

1 file changed

+26
-23
lines changed

README.md

Lines changed: 26 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,32 @@ Replace `<client>` with `claude` or `cursor` as needed.
7070

7171
**No API keys, tokens, or environment variables required!** The server automatically handles authentication via browser OAuth when started.
7272

73+
### 4. Using Docker
74+
75+
#### Building the Docker Image
76+
77+
To build the Docker image for the MCP server, run the following command in the project root:
78+
79+
```bash
80+
docker build -t mcp-server-singlestore .
81+
```
82+
83+
#### Running the Docker Container
84+
85+
To run the Docker container, use the following command:
86+
87+
```bash
88+
docker run -d \
89+
-p 8000:8000 \
90+
-e MCP_API_KEY="your_api_key_here" \
91+
-it \
92+
--name mcp-server \
93+
mcp-server-singlestore
94+
```
95+
96+
Note: An API key is needed when using Docker because the OAuth flow isn't supported locally for servers running in a Docker container. We're working with the Docker team to enable OAuth for local servers in the future. For better security, we recommend using Docker Desktop to configure the S2 MCP server—see [this blog post](https://www.docker.com/blog/docker-mcp-catalog-secure-way-to-discover-and-run-mcp-servers/) for details on Docker's new MCP Catalog.
97+
98+
7399
2. Restart your client after making changes to the configuration.
74100

75101
## Components
@@ -215,26 +241,3 @@ Releases are managed through git tags and automated PyPI publication:
215241
3. **No manual PyPI uploads** - fully automated pipeline
216242

217243
See [`scripts/dev-workflow.md`](scripts/dev-workflow.md) for detailed workflow documentation.
218-
219-
### Building the Docker Image
220-
221-
To build the Docker image for the MCP server, run the following command in the project root:
222-
223-
```bash
224-
docker build -t mcp-server-singlestore .
225-
```
226-
227-
### Running the Docker Container
228-
229-
To run the Docker container, use the following command:
230-
231-
```bash
232-
docker run -d \
233-
-p 8000:8000 \
234-
-e MCP_API_KEY="your_api_key_here" \
235-
-it \
236-
--name mcp-server \
237-
mcp-server-singlestore
238-
```
239-
240-
Note: An API key is needed when using Docker because the OAuth flow isn't supported locally for servers running in a Docker container. We're working with the Docker team to enable OAuth for local servers in the future. For better security, we recommend using Docker Desktop to configure the S2 MCP server—see [this blog post](https://www.docker.com/blog/docker-mcp-catalog-secure-way-to-discover-and-run-mcp-servers/) for details on Docker's new MCP Catalog.

0 commit comments

Comments
 (0)