docs/getting-started
DOCUMENTATION

Getting Started

Get up and running with LumenCore in under 5 minutes.

//What is LumenCore?

LumenCore is a local Model Context Protocol (MCP) server that gives AI coding assistants like Claude Code persistent memory across sessions. It solves the problem of context loss when conversations reset.

When Claude Code connects to LumenCore, it can remember architectural decisions, code patterns, domain knowledge, and project history. All data stays local on your machine in a SQLite database.

//Quick Start

1. Install LumenCore

terminal
npm install -g lumencore

2. Add LumenCore to Claude Code (once per machine)

terminal
claude mcp add lumencore -- lumencore serve

3. Initialize in Your Project

terminal
cd /your/project
lumencore init

The init command sets up everything for seamless integration:

01
Creates/updates CLAUDE.md:Instructs Claude to activate LumenCore at conversation start
02
Configures permissions:Auto-allows all LumenCore tools (no permission prompts)
03
Scans your project:Captures structure, tech stack, and key files

4. Start Claude

terminal
claude

LumenCore activates automatically and loads project context.

//Using LumenCore

Once connected, you can ask Claude Code to use these tools:

lumencore_activate

MCP TOOL

Called automatically at session start. Loads project context and scans new projects.

This tool is called automatically when you start Claude in an initialized project.

remember

MCP TOOL

Store important project knowledge.

"Remember that we decided to use Redux Toolkit for state management because it reduces boilerplate."

recall

MCP TOOL

Search stored memories using full-text search.

"Recall any decisions we made about state management."

//Next Steps