Skip to content

Commit 4a3a692

Browse files
committed
updates
1 parent fc569b3 commit 4a3a692

1 file changed

Lines changed: 9 additions & 10 deletions

File tree

QUICKSTART.md

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -5,18 +5,18 @@
55
```bash
66
git clone https://github.com/neo4j-labs/agent-memory.git
77
cd agent-memory
8-
uv sync --extra mcp && uv pip install uvicorn starlette
8+
uv sync --extra mcp
99
make neo4j-start && make neo4j-wait
1010
export OPENAI_API_KEY=sk-...
1111
uv run python -m neo4j_agent_memory.mcp.server \
12-
--transport streamable-http --port 5000 --neo4j-password test-password
12+
--transport http --port 5000 --neo4j-password test-password
1313
```
1414

1515
> **Note:** `OPENAI_API_KEY` is required for embedding-based search (`memory_search`, `memory_store`). You can also pass it inline:
1616
>
1717
> ```bash
1818
> OPENAI_API_KEY=sk-... uv run python -m neo4j_agent_memory.mcp.server \
19-
> --transport streamable-http --port 5000 --neo4j-password test-password
19+
> --transport http --port 5000 --neo4j-password test-password
2020
> ```
2121
>
2222
> Or use the `--openai-api-key` flag instead of the environment variable.
@@ -25,11 +25,11 @@ Server runs at `http://localhost:5000/mcp`. All CORS origins allowed by default.
2525
2626
## Transports
2727
28-
### Streamable HTTP (recommended)
28+
### HTTP (recommended)
2929
3030
```bash
3131
uv run python -m neo4j_agent_memory.mcp.server \
32-
--transport streamable-http --port 5000 --neo4j-password test-password
32+
--transport http --port 5000 --neo4j-password test-password
3333
```
3434
3535
Endpoint: `http://localhost:5000/mcp` — POST JSON-RPC, get JSON back.
@@ -72,7 +72,7 @@ All origins allowed by default. To restrict:
7272

7373
```bash
7474
uv run python -m neo4j_agent_memory.mcp.server \
75-
--transport streamable-http --port 5000 --neo4j-password test-password \
75+
--transport http --port 5000 --neo4j-password test-password \
7676
--allow-origin https://app.example.com \
7777
--allow-origin https://admin.example.com
7878
```
@@ -91,7 +91,7 @@ uv run python -m neo4j_agent_memory.mcp.server \
9191

9292
| Flag | Default | Description |
9393
|------|---------|-------------|
94-
| `--transport` | `stdio` | `stdio`, `sse`, or `streamable-http` |
94+
| `--transport` | `stdio` | `stdio`, `sse`, or `http` |
9595
| `--port` | `8080` | Port for HTTP transports |
9696
| `--host` | `127.0.0.1` | Bind address (`0.0.0.0` for external) |
9797
| `--neo4j-uri` | `bolt://localhost:7687` | Neo4j URI |
@@ -105,7 +105,6 @@ uv run python -m neo4j_agent_memory.mcp.server \
105105

106106
| Error | Fix |
107107
|-------|-----|
108-
| `No module named 'mcp'` | `uv sync --extra mcp` |
109-
| `SSE transport requires additional dependencies` | `uv pip install uvicorn starlette` |
108+
| `No module named 'fastmcp'` | `uv sync --extra mcp` |
110109
| Neo4j connection refused | `make neo4j-start && make neo4j-wait` |
111-
| Browser client: no tools | Switch to `--transport streamable-http` |
110+
| Browser client: no tools | Switch to `--transport http` |

0 commit comments

Comments
 (0)