Skip to content

Commit 52847b2

Browse files
authored
Add custom catalog example. (#100)
1 parent 9da2311 commit 52847b2

File tree

3 files changed

+42
-0
lines changed

3 files changed

+42
-0
lines changed

examples/custom-catalog/README.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# Using the MCP Gateway with a Custom Catalog
2+
3+
This example shows how you can use your own custom catalog in the MCP Gateway:
4+
5+
+ Defines a custom catalog `catalog.yaml` from which servers can be chosen from.
6+
+ Picks the server `duckduckgo` from the custom catalog.
7+
+ Uses SSE for the transport and can be connected to via `http://localhost:8811/sse`.
8+
9+
## How to run with compose
10+
11+
```console
12+
docker compose up
13+
```
14+
15+
Add client services, like Agents, that connect with the `sse` protocol on port `8811`.
16+
17+
## Running without Compose
18+
19+
```console
20+
docker mcp gateway run --catalog=./catalog.yaml --servers=duckduckgo --transport=sse --port=8811
21+
```
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
registry:
2+
duckduckgo:
3+
description: A Model Context Protocol (MCP) server that provides web search capabilities through DuckDuckGo, with additional features for content fetching and parsing.
4+
title: DuckDuckGo
5+
type: server
6+
image: mcp/duckduckgo@sha256:68eb20db6109f5c312a695fc5ec3386ad15d93ffb765a0b4eb1baf4328dec14f
7+
allowHosts:
8+
- html.duckduckgo.com:443
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
services:
2+
gateway:
3+
image: docker/mcp-gateway
4+
ports:
5+
- "8811:8811"
6+
command:
7+
- --servers=duckduckgo
8+
- --catalog=/mcp/catalog.yaml
9+
- --transport=sse
10+
- --port=8811
11+
volumes:
12+
- /var/run/docker.sock:/var/run/docker.sock
13+
- ./catalog.yaml:/mcp/catalog.yaml

0 commit comments

Comments
 (0)