Skip to content

Commit b18952f

Browse files
authored
docs: polish integration guides for v1.0.1 (#169)
- Bump version refs 1.0.0 → 1.0.1 across all three guides - Fix cargo install: use --git (crates.io 'mimir' is an unrelated package) - Fix Cursor hybrid-search config: --ollama-url/--embedding-model were wrong flags; correct to --llm-endpoint + --llm-model with embedding caveat - Correct tool count 29 → 30 in general-mcp.md; add mimir_get_entity to CRUD - Use absolute paths in Hermes config example (tilde may not expand in MCP spawn)
1 parent 9f157df commit b18952f

3 files changed

Lines changed: 18 additions & 14 deletions

File tree

docs/integration/claude-code.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,14 +12,14 @@ across coding sessions.
1212
# One-shot bootstrap (recommended)
1313
curl -sSL https://raw.githubusercontent.com/Perseus-Computing-LLC/mimir/main/scripts/bootstrap.sh | bash
1414

15-
# Or via cargo
16-
cargo install mimir
15+
# Or build from source via cargo
16+
cargo install --git https://github.com/Perseus-Computing-LLC/mimir
1717
```
1818

1919
Verify:
2020
```bash
2121
mimir --version
22-
# Expected: mimir 1.0.0
22+
# Expected: mimir 1.0.1
2323
```
2424

2525
### 2. Create a data directory

docs/integration/cursor.md

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -12,14 +12,14 @@ and projects.
1212
# One-shot bootstrap (recommended)
1313
curl -sSL https://raw.githubusercontent.com/Perseus-Computing-LLC/mimir/main/scripts/bootstrap.sh | bash
1414

15-
# Or via cargo
16-
cargo install mimir
15+
# Or build from source via cargo
16+
cargo install --git https://github.com/Perseus-Computing-LLC/mimir
1717
```
1818

1919
Verify:
2020
```bash
2121
mimir --version
22-
# Expected: mimir 1.0.0
22+
# Expected: mimir 1.0.1
2323
```
2424

2525
### 2. Create a data directory
@@ -197,11 +197,11 @@ and explore the entity link graph.
197197
If you have Ollama running, Mimir can generate embeddings for hybrid search:
198198

199199
```bash
200-
# Ensure Ollama is running with a model
200+
# Ensure Ollama is running with an embedding-capable model
201201
ollama pull nomic-embed-text
202202
```
203203

204-
Then in your Mimir config, add the LLM configuration in the args:
204+
Then in your Mimir config, configure the LLM endpoint and model:
205205

206206
```json
207207
{
@@ -210,13 +210,17 @@ Then in your Mimir config, add the LLM configuration in the args:
210210
"command": "mimir",
211211
"args": [
212212
"--db", "/home/YOU/.mimir/data/mimir.db",
213-
"--ollama-url", "http://localhost:11434",
214-
"--embedding-model", "nomic-embed-text"
213+
"--llm-endpoint", "http://localhost:11434/api/generate",
214+
"--llm-model", "nomic-embed-text"
215215
]
216216
}
217217
}
218218
}
219219
```
220220

221-
With hybrid search, `mimir_recall` with `search_mode: "hybrid"` combines
221+
> **Note:** `--llm-model` sets the model for BOTH embeddings and `mimir_ask`
222+
> (RAG). If you use `mimir_ask`, choose a model that supports both chat and
223+
> embeddings, or run a separate Mimir instance for each.
224+
225+
With embeddings enabled, `mimir_recall` with `mode: "hybrid"` combines
222226
keyword matching with semantic similarity for better recall.

docs/integration/general-mcp.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ args:
4747
mcp_servers:
4848
mimir:
4949
command: "/usr/local/bin/mimir"
50-
args: ["--db", "~/.mimir/data/mimir.db"]
50+
args: ["--db", "/home/YOUR_USER/.mimir/data/mimir.db"]
5151
timeout: 60
5252
connect_timeout: 30
5353
```
@@ -80,11 +80,11 @@ mcp_servers:
8080
}
8181
```
8282

83-
## All 29 Tools
83+
## All 30 Tools
8484

8585
| Category | Tools |
8686
|---|---|
87-
| **CRUD** | `mimir_remember`, `mimir_recall`, `mimir_forget`, `mimir_recall_when` |
87+
| **CRUD** | `mimir_remember`, `mimir_recall`, `mimir_forget`, `mimir_get_entity`, `mimir_recall_when` |
8888
| **Graph** | `mimir_link`, `mimir_unlink`, `mimir_traverse` |
8989
| **Journal** | `mimir_journal`, `mimir_timeline` |
9090
| **State** | `mimir_state_set`, `mimir_state_get`, `mimir_state_delete`, `mimir_state_list` |

0 commit comments

Comments
 (0)