Skip to content

Commit 361a2b1

Browse files
committed
docs: highlight developer use cases
1 parent 05ba595 commit 361a2b1

1 file changed

Lines changed: 18 additions & 19 deletions

File tree

README.md

Lines changed: 18 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,24 @@ Created by Jean-Baptiste Thery and published under the JCode Labs npm scope.
1919

2020
Built by Jean-Baptiste Thery, freelance full-stack/AI tooling engineer at JCode Labs.
2121

22+
## Developer Use Cases
23+
24+
Mimir is designed for agent-assisted development when the useful context is local, private, and
25+
spread across repositories, specifications, exports, and synced folders.
26+
27+
| Use case | What it enables |
28+
| --- | --- |
29+
| Index a repository's documentation | Ask Claude Code, Codex, Kimi Code CLI, OpenCode, Cline, or another agent to implement features from local README files, architecture notes, API contracts, ADRs, and runbooks. |
30+
| Code from a specification or `cahier des charges` | Turn a local PRD, tender response, client brief, or engineering spec into an implementation plan, acceptance checklist, and cited change guidance. |
31+
| Work from a downloaded Google Drive folder | Point Mimir at files synced locally through Google Drive for desktop, then let the agent retrieve context without uploading the corpus to a hosted RAG service. |
32+
| Onboard to a legacy codebase | Ask where a flow is implemented, which modules own a responsibility, which docs explain a behavior, and what to read before changing risky code. |
33+
| Keep multiple agents on the same evidence | Install the same project skills and MCP server for Claude Code, Codex, Kimi Code CLI, OpenCode, and Cline so each tool retrieves from the same local index. |
34+
| Prepare implementation and review work | Generate cited task breakdowns, migration notes, release checklists, QA plans, and code-review context from the same local sources the team uses. |
35+
| Audit local knowledge coverage | Check which supported files were indexed, which formats were skipped, whether secrets are likely present, and whether golden queries still retrieve expected evidence. |
36+
37+
The workflow stays simple: keep files on disk, run `mimir ingest`, connect your coding agent through
38+
MCP or portable skills, then ask it to work from cited local passages.
39+
2240
## At A Glance
2341

2442
Mimir is the local evidence layer for AI agents: put documents in a repository, index them locally,
@@ -173,25 +191,6 @@ Mimir is not a hosted SaaS, not a remote vector database, and not a certified hi
173191
For regulated or state-grade environments, pair it with encrypted disks, controlled machines,
174192
release verification, and an external security review.
175193

176-
## Use Cases
177-
178-
Mimir is useful whenever source material should stay local but an AI agent still needs grounded
179-
context.
180-
181-
| Use case | Example questions |
182-
| --- | --- |
183-
| Understand a code repository | "Where is authentication implemented?", "What depends on this module?", "Summarize the payment flow." |
184-
| Understand architecture | "What services exist?", "What are the data boundaries?", "Which components are risky to change?" |
185-
| Analyze specifications | "What does the technical spec require?", "Which requirements are still unclear?", "Generate an implementation checklist." |
186-
| Work through a request for proposal or tender | "What are the mandatory constraints?", "Which documents prove compliance?", "What risks should be clarified?" |
187-
| Study courses and training material | "Summarize chapter three.", "Create revision questions.", "Compare these two concepts." |
188-
| Analyze a book or long report | "Extract the main thesis.", "Find recurring arguments.", "Create a chapter-by-chapter brief." |
189-
| Build an internal knowledge base | "What is the policy for incident review?", "Who owns this process?", "Which source says that?" |
190-
| Prepare meetings or decisions | "Give me a one-page briefing.", "What is missing before deciding?", "List action items and evidence." |
191-
| Ask questions over offline documents | "Which files mention local-only operation?", "What evidence supports this claim?" |
192-
| Generate audio briefings | "Create a listenable high-quality or offline summary of the current dossier." |
193-
| Generate Markdown reports | "Write a cited local report with findings, risks, next actions, and sources." |
194-
195194
## Requirements
196195

197196
- Node.js 20 or newer.

0 commit comments

Comments
 (0)