@remnic/server 1.0.2 → 1.0.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +39 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1 +1,39 @@
|
|
|
1
|
-
#
|
|
1
|
+
# @remnic/server
|
|
2
|
+
|
|
3
|
+
Standalone Remnic memory server -- HTTP and MCP interfaces without requiring OpenClaw.
|
|
4
|
+
|
|
5
|
+
Part of [Remnic](https://github.com/joshuaswarren/remnic), the universal memory layer for AI agents.
|
|
6
|
+
|
|
7
|
+
## Install
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
npm install @remnic/server
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Most users should install [`@remnic/cli`](https://www.npmjs.com/package/@remnic/cli) instead, which includes the server and provides daemon management via `remnic daemon start`.
|
|
14
|
+
|
|
15
|
+
## What it does
|
|
16
|
+
|
|
17
|
+
The server exposes Remnic's memory engine over two interfaces:
|
|
18
|
+
|
|
19
|
+
- **HTTP API** -- RESTful endpoints for memory recall, observe, search, and management
|
|
20
|
+
- **MCP (Model Context Protocol)** -- tool-based interface for AI agents that support MCP (Replit, Cursor, etc.)
|
|
21
|
+
|
|
22
|
+
Both interfaces connect to the same [`@remnic/core`](https://www.npmjs.com/package/@remnic/core) engine. All data stays local on your filesystem.
|
|
23
|
+
|
|
24
|
+
## Usage
|
|
25
|
+
|
|
26
|
+
```typescript
|
|
27
|
+
import { createServer } from "@remnic/server";
|
|
28
|
+
|
|
29
|
+
const server = createServer({
|
|
30
|
+
port: 3141,
|
|
31
|
+
authToken: process.env.REMNIC_AUTH_TOKEN,
|
|
32
|
+
});
|
|
33
|
+
|
|
34
|
+
await server.start();
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
## License
|
|
38
|
+
|
|
39
|
+
MIT
|