# OpenLore MCP server

> Gives AI coding agents deterministic, local codebase memory and pre-commit guardrails over MCP, without an LLM in the hot path.

- Repository: https://github.com/clay-good/OpenLore
- Page: https://hostedmcp.org/servers/clay-good/openlore
- Transport: stdio
- Stars: 364
- License: MIT

## Install

### Claude Code

```sh
claude mcp add openlore -- npx -y openlore
```

### Cursor (`~/.cursor/mcp.json`)

```json
{
  "mcpServers": {
    "openlore": {
      "command": "npx",
      "args": [
        "-y",
        "openlore"
      ]
    }
  }
}
```

### VS Code (`.vscode/mcp.json`)

```json
{
  "servers": {
    "openlore": {
      "type": "stdio",
      "command": "npx",
      "args": [
        "-y",
        "openlore"
      ]
    }
  }
}
```

### VS Code CLI

```sh
code --add-mcp '{"name":"openlore","type":"stdio","command":"npx","args":["-y","openlore"]}'
```

### Claude Desktop (`claude_desktop_config.json`)

```json
{
  "mcpServers": {
    "openlore": {
      "command": "npx",
      "args": [
        "-y",
        "openlore"
      ]
    }
  }
}
```

### Codex

```sh
codex mcp add openlore -- npx -y openlore
```

### Codex config.toml (`~/.codex/config.toml`)

```toml
[mcp_servers.openlore]
command = "npx"
args = ["-y", "openlore"]
```

### Gemini CLI

```sh
gemini mcp add -s user openlore npx -- -y openlore
```

### Gemini settings.json (`~/.gemini/settings.json`)

```json
{
  "mcpServers": {
    "openlore": {
      "command": "npx",
      "args": [
        "-y",
        "openlore"
      ]
    }
  }
}
```

## FAQ

### Does OpenLore require an API key?

No. OpenLore runs locally with no API key and no LLM in the hot path, so the same question returns the same grounded answer.

### How do I install and wire OpenLore to my AI coding agent?

Run the npm install command once. It auto-detects supported agents, wires them, registers the MCP server, and builds the index with no config or prompts.

### What can an agent do with the orient tool?

A single orient call returns the relevant functions, callers, specs, tests, and insertion points for a task instead of many exploratory file reads.

### Can OpenLore tell if a change breaks an API consumer?

Yes, certify_public_surface classifies each changed export as breaking, non-breaking, or potentially-breaking and names the consumers each break affects.

### Does OpenLore edit or modify my code?

No. OpenLore is deliberately read-only; it locates and certifies changes but never edits your code.
