Skip to content

Commit bdc83fd

Browse files
mmeclaude
andcommitted
docs(premium/self-hosting): add user memory closed-beta section
Adds two pieces to the self-hosting docs: 1. A short public Callout in `## What is this?` announcing that the Intelligence Platform image includes an opt-in user memory capability and pointing readers at the gated configuration section below. No implementation details exposed. 2. A password-gated `### User memory (closed beta)` sub-section in `## Configuration reference` that describes: - The user-visible effect (recall of prior conversations with example questions) - Scope guarantees (per-user, per-org, per-project; read-only) - The two flips required to enable it: app-api: appApi.env: [{ name: SL_ENABLED, value: "true" }] runtime: mcpServer: true on the CopilotKitIntelligence constructor in @copilotkit/runtime/v2 - A runtime.ts code snippet The gating uses the existing InsecurePasswordProtected component already registered as an MDX component on both (home) and integrations routes. The password is currently hardcoded as cpki-mem-beta directly on the prop, which keeps the gate working locally without env-var setup. Swap to an env-var-backed prop before broader rollout if a different password than the existing LangGraph Cloud beta is desired. Scope of this change is the self-hosting snippet only; no integration-specific docs, no new pages, no nav changes. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
1 parent c2d2046 commit bdc83fd

1 file changed

Lines changed: 46 additions & 0 deletions

File tree

docs/snippets/shared/premium/self-hosting.mdx

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,14 @@ CopilotKit Intelligence — the platform that powers threads, shared state, the
2121

2222
Plus a `database-migrations` Job, a `thread-culler` CronJob, and the usual supporting resources (Services, Ingress, HPAs, PodDisruptionBudgets, ConfigMaps, and — when ESO is enabled — ExternalSecret resources).
2323

24+
<Callout type="info" title="User memory (closed beta)">
25+
The Intelligence Platform image also includes an opt-in user memory
26+
capability: agents can recall information from prior conversations in the
27+
same project (e.g. *"what did we discuss earlier?"*, *"remind me about X"*).
28+
Currently supported with the Built-in Agent runtime. Reach out to your
29+
CopilotKit contact for access; see [Configuration reference → User memory](#user-memory-closed-beta) below for the enablement variables.
30+
</Callout>
31+
2432
## When should I use this?
2533

2634
- Your organization requires CopilotKit Intelligence to run inside your own VPC or data center for compliance, data residency, or security reasons
@@ -474,6 +482,44 @@ The tables below summarize the most common values. For every option, see `values
474482

475483
Enabling the realtime gateway requires that either `realtimeGateway.existingSecret` is set, or that `externalSecrets.secrets.realtimeGateway.enabled` or `selfHostedSecrets.enabled` is `true` — the chart fails validation otherwise.
476484

485+
### User memory (closed beta)
486+
487+
<InsecurePasswordProtected password="cpki-mem-beta">
488+
489+
User memory lets agents recall information from prior conversations in the same project. Built-in Agent runtime only today; LangGraph, Mastra, and other frameworks are in development.
490+
491+
**What it does.** The chat agent can recall the user's prior conversations and use that recall to answer questions like:
492+
493+
- *"What did we discuss last week?"*
494+
- *"Remind me what I decided about X"*
495+
- *"Have we covered Y before?"*
496+
497+
**Scope.** Only the current user's conversations in the current `(organization, project)`. The agent never sees another user's conversations or another project's data, and it cannot modify what was said.
498+
499+
**Discovery.** The agent will use the capability on its own when asked recall-style questions; for best results, add one line to your agent's `prompt` nudging it to consult its memory when relevant.
500+
501+
**Enabling it.** Two flips, one on each side:
502+
503+
| Where | How |
504+
|---|---|
505+
| `app-api` (platform) | Set `SL_ENABLED=true` via `appApi.env: [{ name: SL_ENABLED, value: "true" }]` in your `values.yaml`. This mounts the platform's `/mcp` endpoint on `app-api`. |
506+
| Your runtime / BFF | Pass `mcpServer: true` when constructing `CopilotKitIntelligence` from `@copilotkit/runtime/v2`. The runtime then auto-attaches the platform's `/mcp` endpoint to every `BuiltInAgent` run. |
507+
508+
```typescript title="runtime.ts"
509+
import { CopilotKitIntelligence } from "@copilotkit/runtime/v2";
510+
511+
const intelligence = new CopilotKitIntelligence({
512+
apiKey: process.env.INTELLIGENCE_API_KEY!,
513+
apiUrl: process.env.INTELLIGENCE_API_URL!,
514+
wsUrl: process.env.INTELLIGENCE_GATEWAY_WS_URL!,
515+
mcpServer: true, // [!code highlight]
516+
});
517+
```
518+
519+
Once both flips are in place the agent gains recall on its next turn — no further application changes needed.
520+
521+
</InsecurePasswordProtected>
522+
477523
### External Secrets Operator integration
478524

479525
| Key | Description | Default |

0 commit comments

Comments
 (0)