You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
feat(core)!: add portable knowledge bases and compact MCP defaults
Release highlights:
- export verified, relocatable knowledge-base folders for agents and automations
- return compact MCP evidence by default to reduce agent context use
Release details:
- **Portable bundles:** add export, verify, native, MCP, OpenClaw, and generic adapters
- **Agent UX:** guide three compact citations followed by targeted citation expansion
- **Reliability:** defer automatic LanceDB compaction while preserving manual optimization
- **Documentation:** synchronize Core API, setup, team workflow, and the bilingual landing
Verification:
- pass pnpm validate with tests, builds, package checks, smoke tests, and release gates
- verify English desktop and French mobile pages without browser or network errors
BREAKING CHANGE: MCP search, ask, and research now return compact snippets by default.
Set compact: false when a client needs the previous full-text payload.
Copy file name to clipboardExpand all lines: README.md
+42-10Lines changed: 42 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -27,7 +27,7 @@ The fastest path is to let your coding agent inspect the repository and tailor t
27
27
<summary><strong>Option 1: paste this into your coding agent</strong></summary>
28
28
29
29
~~~text
30
-
Set up Ragmir in this repository. Work interactively: inspect first, ask one concise numbered batch of questions, wait for my answers, then execute. Never assume consent for dependency changes, model downloads, replacing skills, or sharing data.
30
+
Set up Ragmir in this repository. Work interactively: inspect first, infer safe defaults, present a proposal, wait for approval, then execute. Never assume consent for dependency changes, model downloads, replacing skills, or sharing data.
31
31
32
32
Outcome: Core installed with the repository's package manager; useful sources selected; secrets and generated noise excluded; tools connected; cited retrieval verified. Semantic retrieval, team features, Chat, and TTS are optional.
33
33
@@ -36,14 +36,12 @@ Outcome: Core installed with the repository's package manager; useful sources se
36
36
- Detect Node 22+ and pnpm, npm, Yarn, or Bun. Prefer packageManager, then the lockfile. Respect workspace-root flags and mise/asdf/Volta. Never create a second lockfile. If signals conflict, ask.
37
37
- If Ragmir exists, inspect its version, config, status, sources, and rgr upgrade --check before changing it.
38
38
39
-
2. Ask only what the repository did not answer, then wait:
40
-
1) Which repository/monorepo base should own the knowledge base, and are nested app bases wanted?
41
-
2) Which clients: Claude Code, Codex, Kimi, OpenCode, Cline, another MCP client, or none?
42
-
3) Keep default offline local-hash, or allow one semantic-model download for better natural-language retrieval?
43
-
4) Solo or team? If team, is Git upstream authoritative, and should safe pulls be automatic or disabled with --no-pull?
44
-
5) Core only, or optional Chat? For Chat choose lite (~0.49 GB), fast (~3.35 GB), or quality (~5.15 GB).
45
-
6) Optional TTS? Ask language (en/fr/es offline; ja/th/zh require explicit Edge unless a local model is supplied) and whether text may reach Edge.
46
-
7) Which private/external folders are allowed, which must never be indexed, and may I install packages, edit local config, and run approved downloads now?
39
+
2. Propose one setup summary, then ask once:
40
+
- Infer the owning base and useful clients from the repository. State any nested bases you propose.
41
+
- Default to offline local-hash and Core only, or optional Chat only when requested. Optional TTS stays off unless requested. Semantic, Chat, and TTS downloads require explicit approval; Edge text transfer requires separate approval.
42
+
- Default to solo unless the repository or request shows a team workflow. For a Git-backed team, propose the current upstream as authority and safe automatic pulls; offer --no-pull when Git updates must stay manual.
43
+
- List selected source globs, exclusions, any external/private folder, and the exact package, config, skill, and download actions you would perform.
44
+
- Ask only about unresolved choices that materially change source authority, data exposure, downloads, or external execution. Wait for one approval covering the proposal.
47
45
48
46
3. Implement after approval:
49
47
- Install @jcode.labs/ragmir as a dev dependency with the detected manager. Install Chat/TTS only if selected, at a compatible version.
@@ -132,7 +130,7 @@ authentication, authorization, and rate limits.
132
130
| --- | --- | --- |
133
131
|`rgr` CLI | Setup, ingest, search, audit, and maintenance | Human-readable or JSON output |
134
132
| TypeScript API | Scripts and long-running Node.js workers | Typed results and explicit lifecycle |
135
-
| Local MCP server | Coding agents and compatible clients |Bounded, read-focused retrieval tools|
133
+
| Local MCP server | Coding agents and compatible clients |Up to three compact citations by default, with targeted expansion|
136
134
| Ragmir Chat | Fully local answer generation | Answers grounded in verified cited passages |
137
135
| Ragmir TTS | Reviewed text briefs | Local WAV or explicit online MP3 |
138
136
@@ -145,6 +143,9 @@ are optional packages loaded only when their commands are used.
145
143
146
144
Generated MCP helpers pin the project root so an agent queries the intended index. In a monorepo,
147
145
Ragmir selects the nearest `.ragmir/config.json`; root and package bases stay isolated.
146
+
MCP search, ask, and research are compact by default. Agents expand one selected citation instead of
147
+
loading every full passage; research may add up to three code matches, and `compact: false` remains
Copy file name to clipboardExpand all lines: context7.json
+2-1Lines changed: 2 additions & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -23,6 +23,7 @@
23
23
"Use the canonical English setup prompt in docs/quick-start.md for a repository-aware installation; it detects the package manager and existing state, asks before changes or downloads, and verifies retrieval.",
24
24
"Ragmir Core returns cited retrieval context only; it does not synthesize answers itself.",
25
25
"Any compatible coding agent, script, CLI, TypeScript application, or MCP client can consume Core results; use a local consumer when no passage may leave the machine.",
26
+
"Use `rgr portable export` to create a frozen relocatable folder containing the active index, any required local embedding model, a restricted launcher, portable skills, MCP adapters, and a SHA-256 inventory. Raw source files and access logs are excluded, but indexed passages remain sensitive. Verify the folder after moving it and keep action authority in the host agent or automation.",
26
27
"Use one `createRagmirClient()` per project root for repeated work in a stateful Node.js process; it caches one immutable read snapshot until atomic generation replacement and flushes metadata-only access logs during close. Use top-level functions for one-shot scripts.",
27
28
"Ragmir does not open an HTTP port; a network-facing host owns its transport, authentication, authorization, and rate limits.",
28
29
"`rgr chat` is optional add-on generation via @jcode.labs/ragmir-chat; the core remains retrieval-only.",
@@ -45,7 +46,7 @@
45
46
"Generated PDF OCR setup batches up to 16 blank pages and stores private content-addressed page cache entries keyed by source, engine version, language, DPI, parser policy, and command identity. Ingest and preview report only OCR counts and timing.",
46
47
"Vector search is exact below 100,000 rows and uses the compatible IVF-PQ policy stored in the manifest at larger sizes; set `vectorSearchMode: \"exact\"` or use `--exact-vector-search` for diagnostic comparison.",
47
48
"Run `rgr storage optimize --dry-run --json` to inspect full-text, vector, and relative-path index coverage before applying maintenance.",
48
-
"MCP resources `ragmir://context` and `ragmir://sources` are bounded agent-orientation surfaces; retrieval still happens through the read-focused tools.",
49
+
"MCP resources `ragmir://context` and `ragmir://sources` are bounded agent-orientation surfaces; retrieval still happens through the read-focused tools. Search, ask, and research start with at most three compact document citations by default; research may add three code matches. Expand one selected citation or request `compact: false` explicitly.",
49
50
"All ten MCP tools advertise non-destructive behavior and every tool or resource JSON response is byte-bounded. Budget pressure selects typed summaries with exact scalar values, omission counters, and the best search citation instead of shortening identifiers or paths. Search, ask, research, and evaluation conservatively advertise open-world behavior because explicitly enabled semantic models may download public weights. Tools that can initialize local state or append metadata-only logs use conservative read-only and idempotency hints. Each server refreshes its lazy client after effective configuration changes and closes it during shutdown.",
50
51
"MCP `ragmir_evaluate` accepts only an existing project-relative golden file and rejects absolute paths, traversal, and symlinks outside the project. Strict mode returns that relative path, replaces evaluation errors with a generic message, and masks configured model, storage, source, and access-log paths in diagnostic responses."
0 commit comments