Skip to content

Commit 4889fcf

Browse files
tests readme fix
1 parent af31f45 commit 4889fcf

File tree

1 file changed

+9
-6
lines changed

1 file changed

+9
-6
lines changed

tests/README.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,8 @@ heroku ps:scale web=1 -a "$APP_NAME"
2121
```
2222

2323
---
24+
All of these tests will run automatically via github CI when you push up a pull request.
25+
However, if you wish to run these end to end integration tests locally, you can do that too.
2426

2527
## 1 · Install dependencies
2628

@@ -29,22 +31,23 @@ heroku ps:scale web=1 -a "$APP_NAME"
2931
pip install -r requirements.txt
3032
```
3133

32-
## 2 · Run local transports only
34+
## Run E2E Integration Tests
35+
Next, deploy your app. This is required for all E2E tests to run (some tests will be skipped if an app is not deployed & `MCP_SERVER_URL` is not set).
3336
```bash
3437
git push heroku <your-branch>:main
3538
```
3639

37-
## 2 · Run local & one-off-dyno (STDIO) deployed transports
40+
## 1 · Run local & one-off-dyno (STDIO) deployed transports
3841
```bash
39-
pytest tests -q
42+
REMOTE_SERVER_TRANSPORT_MODULE=$(heroku config:get REMOTE_SERVER_TRANSPORT_MODULE) pytest tests -q
4043
```
4144

42-
## 3 - Run local & all deployed transports
45+
## 2 - Run local & all deployed transports
4346
```bash
44-
REMOTE_SERVER_TYPE=$(heroku config:get REMOTE_SERVER_TYPE) \
47+
REMOTE_SERVER_TRANSPORT_MODULE=$(heroku config:get REMOTE_SERVER_TRANSPORT_MODULE) \
4548
MCP_SERVER_URL=$(heroku info -s -a "$APP_NAME" | grep web_url | cut -d= -f2 | tr -d '\n') \
4649
API_KEY=$(heroku config:get API_KEY -a "$APP_NAME") \
4750
pytest tests -q
4851
```
4952

50-
*NOTE: if your `REMOTE_SERVER_TYPE` is set to `sse_server` and not the default `streamable_http_server`, you'll need to change the `REMOTE_SERVER_TRANSPORT_MODULE` declaration line in `.github/workflows/test.yml` to make sure that the end to end integration tests against the temporary deployed remote server are using the appropriate client code.*
53+
*NOTE: if your `REMOTE_SERVER_TRANSPORT_MODULE` is set to `sse_server` and not the default `streamable_http_server`, you'll need to change the `REMOTE_SERVER_TRANSPORT_MODULE` declaration line in `.github/workflows/test.yml` to make sure that the end to end integration tests against the temporary deployed remote server are using the appropriate client code.*

0 commit comments

Comments
 (0)