Skip to content

Commit 8e678d6

Browse files
Add Docker and pkgx MCP configuration examples to README
Co-authored-by: elasticdotventures <[email protected]>
1 parent 4ab4766 commit 8e678d6

File tree

1 file changed

+93
-0
lines changed

1 file changed

+93
-0
lines changed

README.md

Lines changed: 93 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -240,6 +240,99 @@ in `mcp_settings.json`
240240
}
241241
```
242242

243+
### Using Docker with MCP
244+
245+
You can use the Docker image directly in your MCP configuration:
246+
247+
```json
248+
{
249+
"mcpServers": {
250+
"rust-crate-docs-docker": {
251+
"command": "docker",
252+
"args": [
253+
"run",
254+
"--rm",
255+
"-i",
256+
"ghcr.io/promptexecution/rust-cargo-docs-rag-mcp:latest",
257+
"stdio"
258+
]
259+
}
260+
}
261+
}
262+
```
263+
264+
Or if you want to run the HTTP/SSE server in Docker and connect via mcp-remote:
265+
266+
```bash
267+
# Start the HTTP server in Docker
268+
docker run --rm -p 8080:8080 ghcr.io/promptexecution/rust-cargo-docs-rag-mcp:latest
269+
```
270+
271+
Then in `mcp_settings.json`:
272+
```json
273+
{
274+
"mcpServers": {
275+
"rust-crate-docs-docker-http": {
276+
"command": "bunx",
277+
"args": [
278+
"-y",
279+
"mcp-remote@latest",
280+
"http://localhost:8080/sse",
281+
"--allow-http",
282+
"--transport", "sse-only"
283+
]
284+
}
285+
}
286+
}
287+
```
288+
289+
### Using pkgx with MCP
290+
291+
If you have [pkgx](https://pkgx.dev) installed, you can run the server without a system-wide Rust installation:
292+
293+
```json
294+
{
295+
"mcpServers": {
296+
"rust-crate-docs-pkgx": {
297+
"command": "pkgx",
298+
"args": [
299+
"+rust",
300+
"+cargo",
301+
"cargo",
302+
"run",
303+
"--manifest-path",
304+
"/path/to/rust-cargo-docs-rag-mcp/Cargo.toml",
305+
"--bin",
306+
"cratedocs",
307+
"--",
308+
"stdio"
309+
]
310+
}
311+
}
312+
}
313+
```
314+
315+
Or use pkgx to install and run directly:
316+
317+
```bash
318+
# Clone and install with pkgx
319+
git clone https://github.com/promptexecution/rust-cargo-docs-rag-mcp.git
320+
cd rust-cargo-docs-rag-mcp
321+
pkgx +rust +cargo cargo install --path .
322+
```
323+
324+
Then reference it normally in `mcp_settings.json`:
325+
```json
326+
{
327+
"mcpServers": {
328+
"rust-crate-docs": {
329+
"command": "cratedocs",
330+
"args": ["stdio"]
331+
}
332+
}
333+
}
334+
```
335+
243336

244337

245338
### 4. `list_crate_items`

0 commit comments

Comments
 (0)