Prototype · Preview: every server in the official registry, synced every 30 minutes. Sign in with Google to write reviews.Prototype · updated every 30 min
PopNx MCPMCP servers for people who use AI · explained in plain words

Ragmir

by jcode-worksversion 6.15.2i★ 6 (Stars for the whole repo)iRuns on your computerOfficial site ↗
Registry nameio.github.jcode-works/ragmir

How to install

What it does

Cited local retrieval for agents: search code, PDFs, and Office files with exact citations.

  • Connects Runs on your computer
  • Account or key No key needed · 1 setting to fill in (RAGMIR_PROJECT_ROOT)
  • Category Docs, sheets & office work

Use together with

Skills that teach the AI this kind of work; they work alongside this one

MinerU

Transforms complex documents like PDFs and Office docs into LLM-ready markdown/JSON for your Agentic workflows.

by opendatalab★ 83,9191 skills

Skill · How-to guideNo license stated

watermarks-remover

A privacy-first app that strips AI watermarks from content you own.

by guillaumemeyer★ 27,7231 skills

Skill · How-to guide

obsidian-skills

Agent skills for Obsidian. Teach your agent to use Obsidian CLI and open formats including Markdown, Bases, JSON Canvas.

by kepano★ 53,104 (whole repo)5 skills

Skill · How-to guide

Why it ranks here

Lists are ordered by a usage score (out of 100) built from these parts

Popularity8/80GitHub stars or weekly downloads: the larger counts 60, the smaller 20
Freshness12/12Full marks for a release or code change within 30 days
Still answering0/8The cloud endpoint answered at the last check
Usage score20/100

Quality: Passed 3/3 basic checks (shown, not used for ordering) · Momentum: No data yet (Used only on the Trending tab)

Install

Pick the AI app you use, then copy the settings.

Let your AI install it with one sentence

Please install Ragmir. Follow https://mcp.popnx.com/i/jcode-works-ragmir.md, show me the commands and wait for my OK before running them.

Paste it into an AI that can work on your computer (such as Claude Code or Cursor). It reads our steps, shows you the commands and waits for your OK. No key, no sign-up. · See the full text your AI reads

Passed 3/3 checks · Runs on your computer · ✓ Commands checked Nov 16, 2026

First: which AI do you use?

Pick your app and the steps appear below.

Works with Claude, with some setup first

1 setting(s) to fill in (RAGMIR_PROJECT_ROOT) · Install Node.js on your computer first (one time) · Only the Claude desktop app (Windows or Mac), not the web or phone

Let AI install it

Copy this message into a Claude chat. The AI checks your computer, tells you which file it will change, and waits for your OK every time.

Please install the MCP server Ragmir for Claude on this computer, in this order: 1) Check Node.js with node -v. If it is missing, tell me to install it from https://nodejs.org/en/download; do not install it yourself. 2) Use only this config (already checked by PopNx MCP): { "mcpServers": { "ragmir": { "command": "npx", "args": [ "-y", "@jcode.labs/ragmir", "serve-mcp" ], "env": { "RAGMIR_PROJECT_ROOT": "your-value" } } } } 3) Tell me the full path of the file you will change, or the command you will run, and wait for my OK. 4) For RAGMIR_PROJECT_ROOT, leave "your-value" in place and tell me to paste the real value myself into the file or the app’s field. Never ask me to type a key in chat. 5) Do what we agreed, then check that the Ragmir tools really show up.

This message has no key in it. If a key is needed, the AI will ask you to paste it yourself into the file or the app’s field.

  1. Install Node.js (if you don’t have it)

    Already installed? Check first · Open Terminal, type this command and press Enter

    node -v
    • A version number such as v26.13.1 = installed, skip this step
    • "command not found" (on Windows: "is not recognized") = not installed yet, or installed but Terminal needs to be closed and reopened
    How to open Terminal

    Mac: press ⌘ + Space, type Terminal, press Enter

    Windows: open Start, type Windows PowerShell, then Open

    Not installed: Open the official download page, pick the LTS version and the click-through installer: .pkg on Mac · .msi on Windows. Double-click and follow it to the end. No curl command needed

    Open the Node.js download page ↗

    When it’s done, close Terminal, open it again and run the same command. You should see a version number: node -v

    Install once; it works for everything that needs Node.js

  2. Fill in 1 setting(s)

    These are program settings, not keys. No sign-up needed; fill them in as the maker describes.

    • RAGMIR_PROJECT_ROOT Absolute path of the project whose Ragmir base the server reads

    Descriptions are as written by the maker.

  3. Open the Claude desktop app’s settings file

    SettingsDeveloperEdit Config

  4. Paste these settings and save the file

    {
      "mcpServers": {
        "ragmir": {
          "command": "npx",
          "args": [
            "-y",
            "@jcode.labs/ragmir",
            "serve-mcp"
          ],
          "env": {
            "RAGMIR_PROJECT_ROOT": "your-value"
          }
        }
      }
    }
  5. Quit Claude and open it again

  6. Try it

    Use Ragmir and tell me what you can do for me, then show me one thing

    ✓ If Claude says it is using Ragmir or shows a Ragmir tool in the answer, you are connected

Menu names checked against Anthropic’s help page on Nov 11, 2026 · your screen may differ slightly by app version

ChatGPT cannot connect Ragmir yet

Ragmir runs on your computer, but ChatGPT can only connect servers that run on the web

What you can do instead

A · Use an app that can connect Ragmir

  • 1 setting(s) to fill in (RAGMIR_PROJECT_ROOT) · Install Node.js on your computer first (one time) · Only the Claude desktop app (Windows or Mac), not the web or phone
  • 1 setting(s) to fill in (RAGMIR_PROJECT_ROOT) · Install Node.js on your computer first (one time)
  • 1 setting(s) to fill in (RAGMIR_PROJECT_ROOT) · Install Node.js on your computer first (one time)
  • 1 setting(s) to fill in (RAGMIR_PROJECT_ROOT) · Install Node.js on your computer first (one time)

B · Others in Docs, sheets & office work that work with ChatGPT

Picked from the most used in the same category, only ones that connect by address with no key

Works with Claude Code, with some setup first

1 setting(s) to fill in (RAGMIR_PROJECT_ROOT) · Install Node.js on your computer first (one time)

Let AI install it

Copy this message into a Claude Code chat. The AI checks your computer, tells you which file it will change, and waits for your OK every time.

Please install the MCP server Ragmir for Claude Code on this computer, in this order: 1) Check Node.js with node -v. If it is missing, tell me to install it from https://nodejs.org/en/download; do not install it yourself. 2) Use only this config (already checked by PopNx MCP): claude mcp add --scope user ragmir --env RAGMIR_PROJECT_ROOT=your-value -- npx -y @jcode.labs/ragmir serve-mcp 3) Tell me the full path of the file you will change, or the command you will run, and wait for my OK. 4) For RAGMIR_PROJECT_ROOT, leave "your-value" in place and tell me to paste the real value myself into the file or the app’s field. Never ask me to type a key in chat. 5) Do what we agreed, then check that the Ragmir tools really show up.

This message has no key in it. If a key is needed, the AI will ask you to paste it yourself into the file or the app’s field.

  1. Install Node.js (if you don’t have it)

    Already installed? Check first · Open Terminal, type this command and press Enter

    node -v
    • A version number such as v26.13.1 = installed, skip this step
    • "command not found" (on Windows: "is not recognized") = not installed yet, or installed but Terminal needs to be closed and reopened
    How to open Terminal

    Mac: press ⌘ + Space, type Terminal, press Enter

    Windows: open Start, type Windows PowerShell, then Open

    Not installed: Open the official download page, pick the LTS version and the click-through installer: .pkg on Mac · .msi on Windows. Double-click and follow it to the end. No curl command needed

    Open the Node.js download page ↗

    When it’s done, close Terminal, open it again and run the same command. You should see a version number: node -v

    Install once; it works for everything that needs Node.js

  2. Fill in 1 setting(s)

    These are program settings, not keys. No sign-up needed; fill them in as the maker describes.

    • RAGMIR_PROJECT_ROOT Absolute path of the project whose Ragmir base the server reads

    Descriptions are as written by the maker.

  3. Open Terminal

    Mac: press Command+Space and type Terminal · Windows: open PowerShell

  4. Paste this command and press Enter

    claude mcp add --scope user ragmir --env RAGMIR_PROJECT_ROOT=your-value -- npx -y @jcode.labs/ragmir serve-mcp
  5. Type /mcp in Claude Code

    You should see Ragmir listed as connected

  6. Try it

    Use Ragmir and tell me what you can do for me, then show me one thing

    ✓ If Claude Code says it is using Ragmir or shows a Ragmir tool in the answer, you are connected

Menu names checked against Anthropic’s help page on Nov 11, 2026 · your screen may differ slightly by app version

Works with Cursor, with some setup first

1 setting(s) to fill in (RAGMIR_PROJECT_ROOT) · Install Node.js on your computer first (one time)

Let AI install it

Copy this message into a Cursor chat. The AI checks your computer, tells you which file it will change, and waits for your OK every time.

Please install the MCP server Ragmir for Cursor on this computer, in this order: 1) Check Node.js with node -v. If it is missing, tell me to install it from https://nodejs.org/en/download; do not install it yourself. 2) Use only this config (already checked by PopNx MCP): { "mcpServers": { "ragmir": { "command": "npx", "args": [ "-y", "@jcode.labs/ragmir", "serve-mcp" ], "env": { "RAGMIR_PROJECT_ROOT": "your-value" } } } } 3) Tell me the full path of the file you will change, or the command you will run, and wait for my OK. 4) For RAGMIR_PROJECT_ROOT, leave "your-value" in place and tell me to paste the real value myself into the file or the app’s field. Never ask me to type a key in chat. 5) Do what we agreed, then check that the Ragmir tools really show up.

This message has no key in it. If a key is needed, the AI will ask you to paste it yourself into the file or the app’s field.

  1. Install Node.js (if you don’t have it)

    Already installed? Check first · Open Terminal, type this command and press Enter

    node -v
    • A version number such as v26.13.1 = installed, skip this step
    • "command not found" (on Windows: "is not recognized") = not installed yet, or installed but Terminal needs to be closed and reopened
    How to open Terminal

    Mac: press ⌘ + Space, type Terminal, press Enter

    Windows: open Start, type Windows PowerShell, then Open

    Not installed: Open the official download page, pick the LTS version and the click-through installer: .pkg on Mac · .msi on Windows. Double-click and follow it to the end. No curl command needed

    Open the Node.js download page ↗

    When it’s done, close Terminal, open it again and run the same command. You should see a version number: node -v

    Install once; it works for everything that needs Node.js

  2. Fill in 1 setting(s)

    These are program settings, not keys. No sign-up needed; fill them in as the maker describes.

    • RAGMIR_PROJECT_ROOT Absolute path of the project whose Ragmir base the server reads

    Descriptions are as written by the maker.

  3. Click this button to open Cursor

    Open in Cursor

    Cursor asks you to confirm; click Install

  4. Fill in your key

    In the Ragmir settings, RAGMIR_PROJECT_ROOT is empty; add your key and save

  5. Open the AI chat in Cursor in Agent mode

  6. Try it

    Use Ragmir and tell me what you can do for me, then show me one thing

    ✓ If Cursor says it is using Ragmir or shows a Ragmir tool in the answer, you are connected

Menu names checked against Cursor’s help page on Nov 11, 2026 · your screen may differ slightly by app version

Works with VS Code, with some setup first

1 setting(s) to fill in (RAGMIR_PROJECT_ROOT) · Install Node.js on your computer first (one time)

Let AI install it

Copy this message into a VS Code chat. The AI checks your computer, tells you which file it will change, and waits for your OK every time.

Please install the MCP server Ragmir for VS Code on this computer, in this order: 1) Check Node.js with node -v. If it is missing, tell me to install it from https://nodejs.org/en/download; do not install it yourself. 2) Use only this config (already checked by PopNx MCP): { "servers": { "ragmir": { "type": "stdio", "command": "npx", "args": [ "-y", "@jcode.labs/ragmir", "serve-mcp" ], "env": { "RAGMIR_PROJECT_ROOT": "your-value" } } } } 3) Tell me the full path of the file you will change, or the command you will run, and wait for my OK. 4) For RAGMIR_PROJECT_ROOT, leave "your-value" in place and tell me to paste the real value myself into the file or the app’s field. Never ask me to type a key in chat. 5) Do what we agreed, then check that the Ragmir tools really show up.

This message has no key in it. If a key is needed, the AI will ask you to paste it yourself into the file or the app’s field.

  1. Install Node.js (if you don’t have it)

    Already installed? Check first · Open Terminal, type this command and press Enter

    node -v
    • A version number such as v26.13.1 = installed, skip this step
    • "command not found" (on Windows: "is not recognized") = not installed yet, or installed but Terminal needs to be closed and reopened
    How to open Terminal

    Mac: press ⌘ + Space, type Terminal, press Enter

    Windows: open Start, type Windows PowerShell, then Open

    Not installed: Open the official download page, pick the LTS version and the click-through installer: .pkg on Mac · .msi on Windows. Double-click and follow it to the end. No curl command needed

    Open the Node.js download page ↗

    When it’s done, close Terminal, open it again and run the same command. You should see a version number: node -v

    Install once; it works for everything that needs Node.js

  2. Fill in 1 setting(s)

    These are program settings, not keys. No sign-up needed; fill them in as the maker describes.

    • RAGMIR_PROJECT_ROOT Absolute path of the project whose Ragmir base the server reads

    Descriptions are as written by the maker.

  3. Click this button to open VS Code

    Open in VS Code

    VS Code asks you to confirm; click Install

  4. Fill in your key

    In the Ragmir settings, RAGMIR_PROJECT_ROOT is empty; add your key and save

  5. Open the AI chat in VS Code in Agent mode

  6. Try it

    Use Ragmir and tell me what you can do for me, then show me one thing

    ✓ If VS Code says it is using Ragmir or shows a Ragmir tool in the answer, you are connected

Menu names checked against VS Code’s help page on Nov 11, 2026 · your screen may differ slightly by app version

Other apps that use MCP, such as Windsurf, Zed or Gemini CLI, each add servers differently. See how in the app list.

See every app that uses MCP →

JSON settings are under “For developers” below

Stuck? Ask people who use Ragmir💬 Discussion →
For developers: Terminal commands and JSON settings

Installed on your computer

Claude Code

claude mcp add --scope user ragmir --env RAGMIR_PROJECT_ROOT=your-value -- npx -y @jcode.labs/ragmir serve-mcp

Claude Desktop (claude_desktop_config.json)

{
  "mcpServers": {
    "ragmir": {
      "command": "npx",
      "args": [
        "-y",
        "@jcode.labs/ragmir",
        "serve-mcp"
      ],
      "env": {
        "RAGMIR_PROJECT_ROOT": "your-value"
      }
    }
  }
}

Cursor (~/.cursor/mcp.json)

{
  "mcpServers": {
    "ragmir": {
      "command": "npx",
      "args": [
        "-y",
        "@jcode.labs/ragmir",
        "serve-mcp"
      ],
      "env": {
        "RAGMIR_PROJECT_ROOT": "your-value"
      }
    }
  }
}

VS Code (mcp.json)

{
  "servers": {
    "ragmir": {
      "type": "stdio",
      "command": "npx",
      "args": [
        "-y",
        "@jcode.labs/ragmir",
        "serve-mcp"
      ],
      "env": {
        "RAGMIR_PROJECT_ROOT": "your-value"
      }
    }
  }
}

Values you fill in

  • RAGMIR_PROJECT_ROOT required env
    Absolute path of the project whose Ragmir base the server reads

Descriptions are as written by the maker.

These settings are generated from the maker’s registry entry. If the README says otherwise, follow the README.

At a glance

GitHub starsi
6 (Stars for the whole repo)
This repo holds several MCP listings; its stars count once in rankings
Downloads per weeki
327/wk
Licencei
AGPL-3.0
Connection
Runs on your computer
Latest versioni
6.15.2
Published to registryi
Nov 16, 2026
Code last changedi
Nov 16, 2026
Maker
jcode-works
Packages
npm: @jcode.labs/ragmir
oci: ghcr.io/jcode-works/ragmir:6.15.2
Website
ragmir.com
Registry status
Active

Which apps can use it

Based on how this server connects and on each app’s own docs, checked Nov 10, 2026.

Run on your computer in

ClaudeGooseLM StudioMsty StudioCherry StudioCursorVS Code + GitHub CopilotVisual StudioWindsurf (Devin Desktop)ZedKiroClineContinueJetBrains AI AssistantClaude CodeCodex CLIGemini CLIOpenCodenodecodeWarpLibreChatRaycast

All apps, with pros and cons →

Related guides

What it can do

Runs on your computer; the tool list appears in your AI app after you install it.

Basic checksi

We check information anyone can see; we have not read the code. Checks that do not apply are left out of the count. · Checked Nov 19, 2026

  • ✓ Pass

    Maker matches the repo

    The registry name was verified with the GitHub account jcode-works, which owns the repo

  • ✓ Pass

    Still maintained

    Code last changed 3 days ago

  • ✓ Pass

    Has a licence

    Uses AGPL-3.0

  • – Not applicable

    Endpoint responds

    This one runs on your computer; there is no internet endpoint

  • – Not applicable

    Sign-in with OAuth

    Runs on your computer and uses local settings instead

  • … Not checked yet

    No hidden instructions in tool descriptions

    Runs on your computer; we can only read tool lists from internet endpoints

Published vulnerabilities (OSV.dev)

Not checked yet

What we check → · JSON

Makers: ask for a re-check or report wrong info
For makers: add a badge to your README

If you made this, paste this code into your README. The badge links back to this page.

[![Featured on PopNx MCP](https://mcp.popnx.com/badge/jcode-works-ragmir.svg)](https://mcp.popnx.com/en/servers/jcode-works-ragmir)

Discussion

Ask, share a tip or report that it does not work. Sorted by what people marked helpful.

No posts yet. Be the first to ask or share.

Posts here are written by users, not the PopNx team.

Sign in to post

User reviews

No reviews yet

Sign in to write a review

Compared with others in Docs, sheets & office worki

  • More stars than 81% of the other 4126 servers in this category
  • Published to the registry more recently than 90% of the other 4126 servers in this category
  • Basic checks equal to or better than 99% of the other 4126 servers in this category

Compared with every active server in this category in the registry. Stars count only when the publisher owns the repo.

Common questions

Is Ragmir safe?

It passed 3 of 3 applicable basic checks. We have not read the code. Before adding a key or token, see what access the server asks for and use a key with only the permissions you need.

What keys or codes does it need?

The registry does not list a required key, though some servers ask you to sign in on first use.

Does it run on my computer or in the cloud?

It runs on your computer. Your AI app starts it when needed, and data does not pass through the maker’s servers (unless it calls an online service itself).

Is it still maintained?

The GitHub repo last changed 3 days ago, and the latest version (6.15.2) reached the registry 3 days ago.

Which apps can use it?

Apps that support MCP, such as Claude Desktop, Claude Code, Cursor and VS Code. You also need Node.js, Docker on your computer.

What can I use instead?

In the same category: Puter MCP, XcodeBuildMCP, Vexa, Atlassian Rovo MCP Server, Anki MCP Server

Similar alternatives

Same category, other makers, commands already checked. Official ones first, then by stars.

Reading a card:↓ Downloads per weeki★ GitHub starsiThree pillars: reviews · checks · usageiUpdated = latest version published to the registryi

Puter MCP

Puter MCP enables AI tools to interact with Puter: manage files, websites, workers, and more

by HeyPuterWidely used★ 44.2KUpdated 5 months ago

Runs in the cloud✓ service owner · puter.com

XcodeBuildMCP

XcodeBuildMCP provides tools for Xcode project management, simulator management, and app utilities.

by getsentryWidely used↓ 130.5K/wk shared package★ 6.6KUpdated 4 months ago

Runs on your computer✓ service owner · xcodebuildmcp.com

Vexa

Meeting bot and transcripts for Google Meet, Teams and Zoom. Live or after, speakers labelled.

by Vexa-aiWidely used★ 3KUpdated 2 months ago

Runs in the cloud✓ service owner · vexa.ai

Atlassian Rovo MCP Server

Atlassian’s official server lets AI search and manage Jira work and Confluence pages. Connects to Atlassian’s cloud with OAuth sign-in.

by atlassianGrowing★ 1.2KUpdated 2 months ago

Runs in the cloud✓ service owner · atlassian.com

Anki MCP Server

MCP server for Anki flashcards: adaptive review, notes, media, and deck management via AnkiConnect.

by ankimcpGrowing↓ 1.1K/wk★ 567Updated last month

Runs on your computer✓ service owner · ankimcp.ai
Compared with similar ones
This one
Ragmir
Puter MCPXcodeBuildMCPVexaAtlassian Rovo MCP ServerAnki MCP Server
Runs whereInstalls on your computerRuns in the cloud, nothing to installInstalls on your computerRuns in the cloud, nothing to installRuns in the cloud, nothing to installInstalls on your computer
Needs a keyNoNoNoYesNoNo
Add with + in ClaudeNoNoNoNoYesNo
Basic checks3/34/43/32/44/43/3
LicenseAGPL-3.0AGPL-3.0MITApache-2.0Apache-2.0MIT
PriceNo cost listed in the registryNo cost listed in the registryNo cost listed in the registryNo cost listed in the registryNo cost listed in the registryNo cost listed in the registry

README from the maker

Open the README

Copied from the maker’s repo as written. PopNx MCP has not reviewed or endorsed it. HTML, images and scripts are removed. Links lead off this site.

@jcode.labs/ragmir

Cited retrieval for coding agents and the RAG systems you ship. Local, fast, and offline by default.

94% of real developer questions find the right file in the top 10 · 36 ms median search on a 30,171-chunk monorepo · benchmarks

Ragmir indexes the code, specifications, and office documents you choose, then returns precise passages with checkable citations through a TypeScript library, the rgr CLI, or a local MCP server. Claude Code, Codex, or your own application decides what to search and generates with the model you choose. Ragmir does not bundle a chat model or host your documents.

  • Code and documents in one index: hybrid BM25 and vector search that understands paths and camelCase identifiers and boosts the code that defines what you ask about.
  • Fast on real repositories: 36 ms median search on a 30,171-chunk monorepo, with the right source in the top 10 for 94% of real developer questions (benchmarks).
  • Ahead of the usual RAG stacks: the right file reaches the top 3 for 83% of this repository's developer questions, against 63% for a LangChain.js pipeline and 79% for MiniSearch BM25.
  • Evidence you can verify: citations point to source lines or native page, slide, sheet/cell, and EPUB coordinates. Results flag changed files (sourceStatus) and thin support (weakEvidence); questions your sources cannot answer return nothing instead of noise.
  • Always current: rgr doctor checks the files on disk on every run, and rgr hooks install refreshes the index after commits, merges, and checkouts.
  • Private and portable: offline by default, with no account or telemetry, and the same paths, exclusions, and citations on Linux, macOS, and Windows.
  • Ready for the customer's server: parsing, embeddings, the index, and search run in one Node.js process, so forward deployed engineers and AI-native teams can ship RAG on a VPS, an on-premise server, or a container without network access (server guide).

Install and search

Requires Node.js 22.12 or later. Use your project's package manager; this is the npm path:

npm install -D @jcode.labs/ragmir

npx rgr setup --no-ingest --agents claude,codex npx rgr sources add "docs/**/*.md" "specs/**/*.docx" "src/**/*.ts" npx rgr ingest npx rgr search "authentication contract" --compact

rgr setup creates ignored local state under .ragmir/ and installs the selected agent helpers. A committed ragmir.config.json shares sources and settings with your team. The quick start also covers pnpm and guided setup.

Connect your agent

Install Ragmir as a plugin for Claude Code (/plugin install ragmir --marketplace jcode-works/jcode-ragmir), OpenAI Codex, or Cursor, or as an extension for Gemini CLI and Qwen Code; the plugin guide lists every install command. Without a plugin, rgr setup --agents claude,codex prepares a project MCP server and a retrieval skill, and npx skills add jcode-works/jcode-ragmir installs the retrieval, setup, build, and evaluation skills for any agent. The server exposes ragmir_search (one question or up to five related ones sharing a budget, with folder or glob filters and named scopes), ragmir_expand (a citation with its neighbours and the next window of the document), ragmir_sources, ragmir_status, ragmir_audit, and ragmir_ingest to refresh the index after files change. Passages already returned in a session come back as one-line stubs. Its instructions name the base it serves, and it warns or refuses agents working in unrelated projects. See agent integration for connection steps and local or self-hosted model examples. Python applications install ragmir, langchain-ragmir, or llama-index-retrievers-ragmir from PyPI (Python guide), and ghcr.io/jcode-works/ragmir runs Ragmir without Node.js (:full adds semantic search and OCR). LangChain.js chains use RagmirRetriever, and LangChain or LangGraph agents use createRagmirTools, both from @jcode.labs/ragmir/langchain with the optional peer @langchain/core.

TypeScript API

Use one client per project root in a long-running process and close it during shutdown:

import { createRagmirClient } from "@jcode.labs/ragmir"

const ragmir = await createRagmirClient({ cwd: process.cwd() }) try { const passages = await ragmir.search("authentication contract", { topK: 3 }) for (const passage of passages) { console.log(passage.citation, passage.weakEvidence ? "(verify)" : "", passage.text) } if (passages[0]) { console.log(await ragmir.expandCitation(passages[0].citation, { expectedEvidenceId: passages[0].evidence?.id, })) } } finally { await ragmir.close() }

The library also exports top-level ingest, search, and expandCitation functions for one-shot scripts. See the API reference.

Four workflow examples

  1. Build a feature with Claude Code or Codex. The agent finds the specification rules and ADR exceptions with Ragmir, opens the cited passages, then changes the code and tests.
  2. Diagnose an incident with Claude Code or Codex. It retrieves the runbook, incident report, and retry implementation before it changes code and adds a regression test.
  3. Ground an AI product in customer documents. A TypeScript app or a LangChain.js chain gets the exact clause with its page on the customer's server, and no passage when the documents are silent, so the app can say so instead of guessing.
  4. Make a confidential architecture decision. A local or self-hosted chat retrieves cited evidence and sends it to a model you run, with remote calls disabled.

Documents, semantic retrieval, and OCR

Index more than 900 file types: code in over 250 languages, Markdown, PDF, Word, PowerPoint, Excel, OpenDocument, EPUB, HTML, mail and mailboxes, Figma, Sketch, Excalidraw, tldraw, and XMind files, Postman and OpenAPI collections, HAR captures, data models, and diagrams, each cited to its line, page, slide, cell, or object (supported formats). Scanned PDFs, photos, and legacy .doc files use local extractors (rgr ocr setup --images --legacy-word). The default local-hash provider needs no model download. For semantic embeddings, install @huggingface/transformers and run npx rgr setup --semantic: it installs the model this machine suits (multilingual Granite R2 on most) and records it in the project config, and npx rgr models list compares the options. mxbai-embed-xsmall-v1 stays the lightest for English, and multilingual-e5-small remains supported for existing indexes. See choosing an embedding model.

For guided setup, give your agent this prompt:

Agent setup prompt

Set up Ragmir in this repository as a local retrieval tool for developer agents. Inspect first, explain the proposed setup, and act within the authorization already given. Ask only about unresolved source selection, model downloads, external tools, or replacing unmanaged skills.

Outcome: Ragmir installed with the repository's package manager; useful sources selected; secrets and generated noise excluded; agents connected; cited retrieval verified.

  1. Inspect:
  • Find the repository or monorepo root. Read package.json, packageManager, lockfiles, workspace and Node/version-manager files, .gitig

Only the beginning is shown; read the rest in the repo