-
Notifications
You must be signed in to change notification settings - Fork 0
Service Management
Recollectium can run as a managed service for adapters and clients, or as a foreground process for development.
-
api: local HTTP JSON API with memory, workspace, embedding, health, version, and capability operations. -
mcp: MCP HTTP server using SSE transport.
Only one managed service runs at a time.
recollectium service start api
recollectium service start mcpExample success output:
{"endpoint":"http://127.0.0.1:8765","pid":12345,"status":"started","type":"api"}recollectium service statusRunning:
{"endpoint":"http://127.0.0.1:8765","pid":12345,"running":true,"type":"api"}Not running:
{"running":false}recollectium service discover --jsonAdapters should use discovery instead of hardcoding PID files, runtime paths, host, port, or service type.
When a managed service is running, service discover --json returns the compact adapter payload with status, running, type, endpoint, and pid, plus the validation URLs adapters use to confirm the service is healthy. Use --verbose when you need full paths or version metadata.
When no service is running, compact --json discovery exits 1 and prints status: "not_running" output to stdout. Use recollectium service discover --json for adapter or script calls, and add --verbose when you need the full fields.
recollectium service stopRecollectium sends SIGTERM and waits for graceful exit. If needed, it falls back to SIGKILL.
recollectium service restart
recollectium service restart --type api
recollectium service restart --type mcpUse --type when no running service or stale PID metadata can identify the previous type.
recollectium dev serve --host 127.0.0.1 --port 8765dev serve is useful for development and debugging. It blocks until interrupted.
The service manager writes runtime metadata under the configured runtime directory. It includes a PID file and service-discovery.json.
Service stdout and stderr go to service logs in the logs directory. See Logs.
The v1 API and MCP services are unauthenticated. Keep them bound to localhost unless private networking and access controls protect the endpoint.
FAQ
- Is Recollectium cloud-hosted?
- Does Recollectium encrypt the database?
- Does the API have authentication?
- Does the WebUI have authentication?
- Which embedding model does it use?
- Should agents search by type first?
- What is the difference between
dev serveandservice start api? - Can I run Core on one machine and an agent on another?
- Is the OpenCode plugin available?