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: ai/mcp/server/memory-core/openapi.yaml
+27-40Lines changed: 27 additions & 40 deletions
Original file line number
Diff line number
Diff line change
@@ -61,63 +61,50 @@ paths:
61
61
schema:
62
62
$ref: '#/components/schemas/ErrorResponse'
63
63
64
-
/db/start:
64
+
/db/manage:
65
65
post:
66
-
summary: Start Database
67
-
operationId: start_database
66
+
summary: Manage Database
67
+
operationId: manage_database
68
68
description: |
69
-
Starts the ChromaDB database instance for the Memory Core as a background process, or connects to an existing one.
69
+
Manages the lifecycle (start/stop) of the ChromaDB database instance for the Memory Core.
70
70
71
71
**Behavior:**
72
-
- **Managed:** If no database is running on the configured port, this tool spawns a new process managed by this server. This process will be automatically cleaned up when the agent session ends.
73
-
- **External:** If a database is already running (e.g., via `npm run ai:server-memory`), this tool simply confirms the connection. The server acts as a client and will NOT kill the database on exit.
72
+
- **Start:**
73
+
- **Managed:** If no database is running on the configured port, this tool spawns a new process managed by this server. This process will be automatically cleaned up when the agent session ends.
74
+
- **External:** If a database is already running (e.g., via `npm run ai:server-memory`), this tool simply confirms the connection. The server acts as a client and will NOT kill the database on exit.
75
+
- **Stop:**
76
+
- **Managed:** Stops the process spawned by this server.
77
+
- **External:** **No effect.** The server cannot stop a database it did not start.
74
78
75
79
**Multi-Agent / Swarm Recommendation:**
76
80
For workflows involving multiple concurrent agents, it is **highly recommended** to start the database externally using `npm run ai:server-memory` before starting the agents. This prevents unexpected disconnects for other agents when the "owner" agent exits.
77
81
78
82
**When to Use:**
79
-
Use this tool if a `healthcheck` reveals that the database process is not running.
80
-
tags: ["Database Lifecycle"]
81
-
responses:
82
-
'200':
83
-
description: The database process was started successfully.
description: The database process is already running or failed to start.
90
-
content:
91
-
application/json:
92
-
schema:
93
-
$ref: '#/components/schemas/ErrorResponse'
94
-
95
-
/db/stop:
96
-
post:
97
-
summary: Stop Database
98
-
operationId: stop_database
99
-
description: |
100
-
Stops the running ChromaDB database instance for the Memory Core.
101
-
102
-
**Debug / Maintenance Tool:**
103
-
This tool is generally **not required** for standard workflows. The server now implements automatic process cleanup (for managed instances) when the session concludes.
104
-
105
-
**Effect:**
106
-
- **Managed:** Stops the process spawned by this server.
107
-
- **External:** **No effect.** The server cannot stop a database it did not start.
108
-
109
-
**When to Use:**
110
-
Use this only for debugging, forcing a restart, or freeing up resources in a long-running environment where the agent session itself does not exit.
83
+
- Use `action: start` if a `healthcheck` reveals that the database process is not running.
84
+
- Use `action: stop` for debugging, forcing a restart, or freeing up resources.
111
85
tags: ["Database Lifecycle"]
86
+
requestBody:
87
+
required: true
88
+
content:
89
+
application/json:
90
+
schema:
91
+
type: object
92
+
required:
93
+
- action
94
+
properties:
95
+
action:
96
+
type: string
97
+
enum: [start, stop]
98
+
description: The action to perform.
112
99
responses:
113
100
'200':
114
-
description: The database process was stopped successfully.
0 commit comments