Skip to content

Commit 690b210

Browse files
committed
docs: update Docker usage instructions
1 parent e56bdda commit 690b210

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

README.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,16 @@ npx mcp-server-nodejs-api-docs
2626

2727
You can debug calls for the MCP Server by inspecting the file `/tmp/mcp-server-nodejs-docs.log` which this MCP Server writes to.
2828

29+
## Usage: as a Docker container
30+
31+
You can run this MCP Server as a Docker container by using the following command:
32+
33+
```bash
34+
docker pull ghcr.io/lirantal/mcp-server-nodejs-api-docs:latest
35+
```
36+
37+
You can also use the Docker image directly in your MCP Server configuration for various applications, see examples below.
38+
2939
## Usage for Claude Desktop:
3040

3141
Edit your Claude Desktop MCP Servers configuration file (located on macOS here: `~/Library/Application Support/Claude/claude_desktop_config.json`) and add the following:
@@ -41,6 +51,19 @@ Edit your Claude Desktop MCP Servers configuration file (located on macOS here:
4151
}
4252
```
4353

54+
or with the Docker image:
55+
56+
```json
57+
{
58+
"mcpServers": {
59+
"nodejs-api-docs": {
60+
"command": "docker",
61+
"args": ["run", "--rm", "--init", "-e", "DOCKER_CONTAINER=true", "ghcr.io/lirantal/mcp-server-nodejs-api-docs:latest"]
62+
}
63+
}
64+
}
65+
```
66+
4467
## Usage for Cursor AI:
4568

4669
Edit your Cursor AI MCP file (located at `~/.cursor/mcp.json`) and add the following:

0 commit comments

Comments
 (0)