Xmem Openclaw

README

# xmem-openclaw

OpenClaw plugin bundle and MCP connector for XMem persistent memory.

This package connects OpenClaw to XMem through the XMem MCP server. It writes local connector configuration and agent-facing memory instructions, while keeping XMem credentials in environment variables.

## Install

```bash
npx xmem-openclaw@latest install
```

For local development:

```bash
node src/cli.js install --config-root ./tmp/openclaw
```

## Authentication

Set credentials in your shell, OS secret store, or the client environment before launching OpenClaw:

```bash
export XMEM_API_URL="https://api.xmem.in"
export XMEM_API_KEY="xmem_..."
export XMEM_USERNAME="your-xmem-username"
```

The installer intentionally writes `${XMEM_API_KEY}` as a placeholder instead of copying secret values into config files.

## Commands

| Command | Description |
| --- | --- |
| `install` | Write openclaw.plugin.json plus .mcp.json. |
| `doctor` | Check whether generated connector files exist. |
| `smoke-test` | Verify XMem API access via environment variables without printing secrets. |

## Smoke test

```bash
XMEM_API_KEY="xmem_..." XMEM_USERNAME="connector-test" npm run smoke
```

The smoke test calls XMem search with a low-risk read query. It never logs the API key.

## Notes

- Requires the XMem MCP server to be available as `uvx xmem-mcp`.
- Uses stdio transport by default for local agent clients.
- You can override the API URL with `--api-url` during install.

## License

Apache-2.0