You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/cli.md
+10-9Lines changed: 10 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -27,15 +27,16 @@ agent-memory api [OPTIONS]
27
27
-`--port INTEGER`: Port to run the server on. (Default: value from `settings.port`, usually 8000)
28
28
-`--host TEXT`: Host to run the server on. (Default: "0.0.0.0")
29
29
-`--reload`: Enable auto-reload for development.
30
-
-`--no-worker`: Use FastAPI background tasks instead of Docket workers. Ideal for development and testing.
30
+
-`--task-backend [asyncio|docket]`: Background task backend. `docket` (default) uses Docket-based background workers (requires a running `agent-memory task-worker` for non-blocking tasks). `asyncio` runs tasks inline in the API process and does **not** require a separate worker.
31
+
-`--no-worker` (**deprecated**): Backwards-compatible alias for `--task-backend=asyncio`. Maintained for older scripts; prefer `--task-backend`.
31
32
32
33
**Examples:**
33
34
34
35
```bash
35
-
# Development mode (no separate worker needed)
36
-
agent-memory api --port 8080 --reload --no-worker
36
+
# Development mode (no separate worker needed, asyncio backend)
37
+
agent-memory api --port 8080 --reload --task-backend asyncio
37
38
38
-
# Production mode (requires separate worker process)
39
+
# Production mode (default Docket backend; requires separate worker process)
39
40
agent-memory api --port 8080
40
41
```
41
42
@@ -51,22 +52,22 @@ agent-memory mcp [OPTIONS]
51
52
52
53
-`--port INTEGER`: Port to run the MCP server on. (Default: value from `settings.mcp_port`, usually 9000)
53
54
-`--mode [stdio|sse]`: Run the MCP server in stdio or SSE mode. (Default: stdio)
54
-
-`--no-worker`: Use FastAPI background tasks instead of Docket workers. Ideal for development and testing.
55
+
-`--task-backend [asyncio|docket]`: Background task backend. `asyncio` (default) runs tasks inline in the MCP process with no separate worker. `docket` sends tasks to a Docket queue, which requires running `agent-memory task-worker`.
55
56
56
57
**Examples:**
57
58
58
59
```bash
59
-
# Stdio mode (recommended for Claude Desktop) - automatically uses --no-worker
60
+
# Stdio mode (recommended for Claude Desktop) - default asyncio backend
60
61
agent-memory mcp
61
62
62
63
# SSE mode for development (no separate worker needed)
**Note:** Stdio mode automatically disables Docket workers as they're not needed when Claude Desktop manages the process lifecycle.
70
+
**Note:** Stdio mode is designed for tools like Claude Desktop and, by default, uses the asyncio backend (no worker). Use `--task-backend docket` if you want MCP to enqueue background work into a shared Docket worker.
Copy file name to clipboardExpand all lines: docs/getting-started.md
+7-7Lines changed: 7 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -28,10 +28,10 @@ But you can also run these components via the CLI commands. Here's how you
28
28
run the REST API server:
29
29
30
30
```bash
31
-
# Development mode (no separate worker needed)
32
-
uv run agent-memory api --no-worker
31
+
# Development mode (no separate worker needed, asyncio backend)
32
+
uv run agent-memory api --task-backend asyncio
33
33
34
-
# Production mode (requires separate worker process)
34
+
# Production mode (default Docket backend; requires separate worker process)
35
35
uv run agent-memory api
36
36
```
37
37
@@ -42,10 +42,10 @@ Or the MCP server:
42
42
uv run agent-memory mcp
43
43
44
44
# SSE mode for development
45
-
uv run agent-memory mcp --mode sse --no-worker
46
-
47
-
# SSE mode for production
48
45
uv run agent-memory mcp --mode sse
46
+
47
+
# SSE mode for production (use Docket backend)
48
+
uv run agent-memory mcp --mode sse --task-backend docket
49
49
```
50
50
51
51
### Using uvx in MCP clients
@@ -80,7 +80,7 @@ Notes:
80
80
uv run agent-memory task-worker
81
81
```
82
82
83
-
**For development**, use the `--no-worker` flag to run tasks inline without needing a separate worker process.
83
+
**For development**, the default `--task-backend=asyncio` on the `mcp` command runs tasks inline without needing a separate worker process. For the `api` command, use `--task-backend=asyncio` explicitly when you want single-process behavior.
84
84
85
85
**NOTE:** With uv, prefix the command with `uv`, e.g.: `uv run agent-memory --mode sse`. If you installed from source, you'll probably need to add `--directory` to tell uv where to find the code: `uv run --directory <path/to/checkout> run agent-memory --mode stdio`.
0 commit comments