slm-scope

Files (1)

• SKILL.md

SKILL.md (first lines)

# slm-scope — Memory Scope and Sharing Model

SuperLocalMemory is profile-isolated by default. Every profile is a fully
independent memory namespace. The scope model adds controlled, opt-in sharing
between profiles on the same machine — it is never active unless you explicitly
set it.

---

## The Three Scopes

| Scope | Visibility | When to use |
|-------|-----------|-------------|
| `personal` | Active profile only | Default — all facts. Never set explicitly. |
| `shared` | Active profile + `shared_with` profiles | Team handoffs, shared project context |
| `global` | Every profile on this machine | Machine-wide conventions, org-wide rules |

**The default is always `personal`.** A fact stored without a `scope` argument
is private to the profile that stored it. Recall without scope flags returns only
personal facts. This is identical to single-profile SLM.

---

## Opt-in is mandatory

Never set `scope="shared"` or `scope="global"` (or the recall equivalents
`include_shared`, `include_global`) unless the user explicitly asks you to share
or read across profiles. This is a hard rule — scope expansion is an action with
team-wide or machine-wide impact, and it must always be user-initiated.

---

## Writing a shared or global fact

### share with specific profiles

```
remember(
  content="API gateway rate limit is 1000 req/min per client",
  tags="api,limits,ops",
  project="platform",
  importance=8,
  session_id="<sid>",
  scope="shared",
  shared_with="devops-profile,backend-profile",
)
```

`shared_with` is a comma-separated list of profile IDs that should be able to
recall this fact. Use `slm status` to see the current profile name — that is the
`profile_id` to supply.

### share with all profiles on the machine

```
remember(
  content="All services must enforce TLS 1.3 minimum",
  tags="security,tls,global",
  project="infra",
  importance=9,
  session_id="<sid>",
  scope="global",
)
```

`scope="global"` makes the fact visible to every profile on this machine. Use
this only for machine-wide conventions (security rules, org-wide constraints).

---

## Reading shared or global facts

By default, `recall` returns only the active profile's personal facts. To surface
shared and global facts, pass the opt-in flags:

```
recall(
  query="rate limiting rules",
  limit=20,
  include_global=True,   # include global-scope facts
  include_shared=True,   # include facts shared with this profile
  session_id="<sid>",
)
```

You can opt in to either or both flags independently. Only the active profile's
permitted shared facts are returned — you cannot read another profile's personal
facts.

### CLI equivalents

```bash
# Recall with global facts included
slm recall "rate limiting rules" --include-global

# Recall with shared facts included
slm recall "rate limiting rules" --include-shared

# Both
slm recall "rate limiting rules" --include-global --include-shared

# Store a global fact
slm remember "TLS 1.3 minimum" --scope global

# Store a shared fact (shared-with is a comma-separated list of profile IDs)
slm remember "API rate limit 1000/min" --scope shared --shared-with devops,backend
```

CLI flags: `--include-global` / `--no-global`, `--include-shared` / `--no-shared`
on `slm recall`; `--scope personal|shared|global` and `--shared-with <profile-ids>`
on `slm remember`. Leaving a flag unset uses the configured default.

---

## Configuring scope defaults

The defaults live in the `scope` section of the mode config files (`mode_a.json`,
`mode_b.json`, `mode_c.json`, and the active `config.json`). To make a profile's
recalls always include global facts without passing a flag each time:

From qualixar/superlocalmemory, AGPL-3.0.

More from qualixar/superlocalmemory