Skip to content

Commit 06b28c7

Browse files
committed
docs: update instructions
Signed-off-by: Dominik Kolonits <[email protected]>
1 parent a575fbd commit 06b28c7

File tree

6 files changed

+43
-13
lines changed

6 files changed

+43
-13
lines changed

Taskfile.yaml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,8 @@ includes:
1616

1717
mcp-proxy:
1818
taskfile: mcp-proxy/Taskfile.yaml
19+
flatten: true
20+
dir: ./mcp-proxy
1921

2022
vars:
2123
CARGO_COMPONENTS: "cargo-sort cargo-audit cargo-llvm-cov cargo-machete cargo-deny typos-cli"

mcp-proxy/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,12 @@ You can use the commands provided in the Taskfile to run the client and server l
77
### Run the SLIM node
88
To run the SLIM node, use the following command:
99
```bash
10-
task mcp-proxy:run-slim
10+
task mcp-proxy:test:run-slim
1111
```
1212
### Run the SLIM-MCP proxy
1313
To run the SLIM-MCP proxy, use the following command:
1414
```bash
15-
task mcp-proxy:run-mcp-proxy
15+
task mcp-proxy:run
1616
```
1717
### Run the MCP Server
1818
To run the MCP server example, use the following command:

mcp-proxy/Taskfile.yaml

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,14 +12,21 @@ vars:
1212
CARGO_COMPONENTS: "cargo-sort cargo-audit cargo-llvm-cov [email protected] [email protected] typos-cli"
1313

1414
tasks:
15-
test:run-mcp-server:
15+
mcp-proxy:test:run-slim:
16+
desc: run slim instance
17+
cmds:
18+
- |
19+
cd examples/config/
20+
docker run -it -v ./slim-server-config.yaml:/config.yaml -p 46357:46357 ghcr.io/agntcy/slim:1.0.0 /slim --config /config.yaml
21+
22+
mcp-proxy:test:run-mcp-server:
1623
desc: run mcp server using SSE transport
1724
cmds:
1825
- |
1926
cd examples/mcp-server/
2027
uv run main.py --port 8000
2128
22-
run-mcp-proxy:
29+
mcp-proxy:run:
2330
desc: run mcp proxy
2431
dir: "{{.TASKFILE_DIR}}"
2532
cmds:
@@ -28,21 +35,21 @@ tasks:
2835
--svc-name slim/0 --name org/mcp/proxy \
2936
--mcp-server http://localhost:8000/mcp
3037
31-
test:run-mcp-client:
38+
mcp-proxy:test:run-mcp-client:
3239
desc: run a simple MCP client that use SLIM as transport protocol
3340
cmds:
3441
- |
3542
cd examples/mcp-slim-client
3643
uv run main.py
3744
38-
test:reinstall-and-run-mcp-client:
45+
mcp-proxy:test:reinstall-and-run-mcp-client:
3946
desc: run a simple MCP client that use SLIM as transport protocol
4047
cmds:
4148
- |
4249
cd examples/mcp-slim-client
4350
uv run --reinstall main.py
4451
45-
build:strip:
52+
mcp-proxy:build:strip:
4653
desc: "Build the project and strip the debug symbols"
4754
cmds:
4855
- task: :build
Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# Copyright AGNTCY Contributors (https://github.com/agntcy)
2+
# SPDX-License-Identifier: Apache-2.0
3+
4+
tracing:
5+
log_level: info
6+
display_thread_names: true
7+
display_thread_ids: true
8+
9+
runtime:
10+
n_cores: 0
11+
thread_name: "slim-data-plane"
12+
drain_timeout: 10s
13+
14+
services:
15+
slim/0:
16+
dataplane:
17+
servers:
18+
- endpoint: "0.0.0.0:46357"
19+
tls:
20+
insecure: true
21+
clients: []
Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
# MCP Client
2-
This is a simple example of an MCP client that uses the SLIM protocol to transport messages to the server.
1+
# MCP Server
2+
This is a simple example of an MCP server that uses the SSE transport.
33

44
## How to run the code
55
You can run the code using the command provided in the Taskfile:
66
```bash
7-
task mcp-proxy:run-mcp-client
7+
task mcp-proxy:test:run-mcp-server
88
```
Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
# MCP Server
2-
This is a simple example of an MCP server that uses the SSE transport.
1+
# MCP Client
2+
This is a simple example of an MCP client that uses the SLIM protocol to transport messages to the server.
33

44
## How to run the code
55
You can run the code using the command provided in the Taskfile:
66
```bash
7-
task mcp-proxy:run-mcp-server
7+
task mcp-proxy:test:run-mcp-client
88
```

0 commit comments

Comments
 (0)