# Scopes

Keep user-owned memory boundaries explicit as clients and agents move between projects and sessions.

- Canonical: https://docs.xmemo.dev/docs/concepts/scopes
- Locale: en-US
- Content-Locale: en-US
- Canonical-Content-Digest: 4f379b3876aebec1fc076f80ef4f0a7d3e5380ae604a81c3738b73f9f0b96014
- Edition-Digest: a5808199bd67b16cede2d886be41991a6a911158fda675f9fcf5c771d38804ac
- Source-Revision: sha256:089b330ed72fcdfbd82d9f260a10b5a4b898c74d5792d268a6626bfd647790b1

## Bucket and scope are different boundaries

Bucket is the storage namespace. Scope is the project, session or team boundary used for retrieval. Keeping them separate is what lets one account hold several projects without their memories bleeding into each other.

- bucket — storage namespace, commonly work for agent process memory.
- scope — explicit project/session/team grouping applied at retrieval time.
- path — logical location inside a scope, filtered with an ILIKE pattern.
- team_id — restricts retrieval to one team the caller can already access.

## Retrieve inside one scope

Pass scope on a search to keep results inside one project boundary. Scope is validated against the authenticated token; it cannot widen access.

```http
GET /v1/memories/search?query=MCP%20token%20context&scope=memory-os&memory_type=semantic&limit=5
X-API-Key: <your-assigned-api-key>
```

## Scope from the SDK

The TypeScript client takes the same boundary arguments, so capture and recall stay inside the project the caller is authorized for.

```ts
const search = await client.search('MCP token context', {
  scope: 'memory-os',
  memoryType: 'semantic',
  candidateCount: 20,
  explain: true,
});
```

## ChatGPT user

Give ChatGPT durable access to your XMemo preferences, project facts, decisions, and TODOs without pasting bearer tokens into a chat.

Connect the hosted XMemo MCP server through the ChatGPT/OpenAI app OAuth flow, then approve the memory:read and memory:write grant for your XMemo account.

Save a synthetic preference or project note, start a new chat, then ask ChatGPT to recall it through XMemo before continuing work.

If OAuth fails or tools do not appear, sign out of the MCP server in the host app, reconnect the XMemo server URL, and retry before creating direct tokens.

## Copilot / Codex developer

Carry repo decisions, coding conventions, bug-fix notes, and task history between IDE and CLI agents.

Use OAuth for VS Code / GitHub Copilot and Gemini CLI when available. For Copilot CLI, Codex, Cursor, or other direct MCP clients, keep XMEMO_KEY in the local environment or secret store and set a stable XMEMO_AGENT_INSTANCE_ID.

Record a codebase decision or bug fix, then ask the next IDE or CLI agent to recall the relevant XMemo context before editing.

If recalls are empty, verify the selected MCP config path, the XMEMO_KEY environment variable for direct clients, and any stale OAuth credential in the host app.

## Team / enterprise pilot owner

Evaluate shared memory with account controls, source attribution, export/delete workflows, and reviewer-safe setup evidence.

Create or enter the protected XMemo workspace, invite approved users, then connect each client through OAuth or a scoped direct credential according to the readiness badges.

Have a pilot member save a synthetic team memory, confirm source attribution in XMemo, then review delete/export and support paths.

If a member cannot connect, check role permissions, OAuth approval, client readiness status, and support guidance before issuing a new token.

## Autonomous agent operator

Let headless or scheduled agents record progress, retrieve prior decisions, and keep a stable non-secret instance identity.

Fetch /api/v1/mcp/config/autonomous-agent. Prefer auth_modes.oauth when the runner supports OAuth + custom headers; use auth_modes.xmemo_key with XMEMO_KEY from a secret store only for fully headless runners.

Run one synthetic task that writes progress to XMemo, restart the runner, and confirm it recalls that progress using the same XMEMO_AGENT_INSTANCE_ID.

If attribution changes or recalls split across instances, persist XMEMO_AGENT_INSTANCE_ID outside git and verify the runner is not regenerating it on every start.