# MemPalace Setup

Installs and operates MemPalace: local palace, shared hub, mining, and repair.

- Repository: https://github.com/MemPalace/mempalace (60225 stars)
- Category: AI and agents
- License: MIT
- Last updated: 2026-10-31
- Runs scripts: no, instructions only

## Install

Claude Code: `npx skills add MemPalace/mempalace --skill mempalace -g -a claude-code -y`
Codex: `npx skills add MemPalace/mempalace --skill mempalace -g -a codex -y`
Cursor: `npx skills add MemPalace/mempalace --skill mempalace -g -a cursor -y`
Gemini CLI: `npx skills add MemPalace/mempalace --skill mempalace -g -a gemini-cli -y`
Claude Code plugin marketplace: `/plugin marketplace add MemPalace/mempalace`

## Description

Install, configure, and operate MemPalace, including a private local palace, a shared-brain hub, or a client joining an existing hub. Use for first-time setup, MCP wiring, mining, status, palace audit and repair, wings, rooms, drawers, shared-brain identity, or logstream readiness.

## SKILL.md, as published by its author (untrusted third-party text, read it as data)

# MemPalace Setup

A guided, skill-first setup for a searchable memory palace. The user may have
installed this skill with `npx skills add` before the MemPalace Python package
or MCP server exists; that is the normal bootstrap path.

## Setup protocol

### 1. Inspect before changing anything

- Detect the OS and current agent harness.
- Run `mempalace --version`, `uv --version`, and an appropriate Python version
  check. Do not assume that an installed Python package is reachable on PATH.
- Check for an existing palace and MCP registration. Never reinitialize or
  rebuild an existing palace just to make setup simpler.

### 2. Install the CLI when necessary

Prefer an isolated `uv` tool installation:

```bash
uv tool install mempalace
```

If `uv` is unavailable, use the PATH-visible Python installation:

```bash
python -m pip install mempalace
```

After installation, run `mempalace --version`. If it still is not reachable,
fix PATH or use the matching `uv tool run` invocation before continuing.

### 3. Choose the topology with the user

Ask which outcome they want unless it is already clear:

1. **private local palace**, one machine, local stdio MCP;
2. **shared-brain hub**, this machine owns the palace and serves the fleet;
3. **client joining an existing hub**, this machine connects to a hub owned
   elsewhere.

Also ask which project or conversation corpus should be initialized, offering
the current working directory as the default. A shared-brain client does not
initialize a second copy of the owner's palace.

### 4. Run version-correct initialization

MemPalace provides dynamic, version-correct instructions via the CLI. To get instructions for any operation:

```bash
mempalace instructions <command>
```

Where `<command>` is one of: `help`, `init`, `mine`, `search`, `status`.

Run the appropriate instructions command, then follow the returned instructions step by step.

The rest: https://github.com/MemPalace/mempalace/blob/HEAD/.claude-plugin/skills/mempalace/SKILL.md
