Skip to main content

MIMRY

Finds the files a coding task touches, so your agent reads less.

71% fewer tokens to reach the code a task changes, in a scripted retrieval benchmark.

PyPI GitHub stars CI Python 3.11+ License MIT Website

If MIMRY saves your agent tokens, please star it.

MIMRY is a command-line tool that tells AI coding agents which files, and which lines in them, to read for a task. It parses a repository into symbols and a dependency graph, keeps the index on your machine, and ranks the files that matter for a task described in plain words. The index is deterministic: the same code gives the same graph, rankings and context pack on Windows, Linux and macOS, and no LLM is involved in building it. Agents call it from the shell or through its MCP server.

mimry preflight in a terminal: it ranks the Flask files for a session cookie bug and names the lines to read first

Installation

Get started in four steps.

  1. Install uv, the tool that installs MIMRY. Pick the command for your system. macOS or Linux:

    curl -LsSf https://astral.sh/uv/install.sh | sh
    

    Windows, in PowerShell:

    powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"
    

    Then open a new terminal. Already have uv? Skip this step. For other ways to install uv, see the uv installation guide.

  2. Install MIMRY.

    uv tool install mimry
    

    MIMRY needs Python 3.11 or newer on Windows, Linux or macOS. uv downloads a suitable Python itself if none is installed. If the shell says mimry is not found, run uv tool update-shell, then open a new terminal.

  3. Connect your agent. This is what makes the agent use MIMRY on its own. Claude Code users pick one of these two, not both:

    /plugin marketplace add jbacalso24/mimry
    /plugin install mimry@mimry
    

    or run mimry install --platform claude-code. Other agents: run mimry install --platform <name>, see Supported agents.

    mimry install --platform claude-code also adds MIMRY's hooks, which steer the agent to MIMRY and do nothing in folders MIMRY has not set up. Add --no-hooks to leave them out. With --project, --always-on also adds MIMRY's rules to the agent's always-read file.

  4. Check it works. In a repository, run mimry preflight "<a task in your own words>". The first run builds the index and downloads the tree-sitter grammars it needs, once per user. If something looks off, run mimry doctor.

Other ways to install

These replace steps 1 and 2, or add an optional feature.

Quick start

Run mimry preflight in your repository with a task description. The first run builds the index.

mimry preflight "Fix session cookie not refreshed when SESSION_REFRESH_EACH_REQUEST is set"

Output on the Flask repository:

Start with
   1  src/flask/sessions.py
      name matches · path matches · connected to other matches
      read first: lines 202-206 (get_cookie_secure), 233-247 (should_set_cookie)
   2  src/flask/ctx.py
      name matches · connected to other matches
      read first: lines 154-206 (copy_current_request_context), 395-403 (session)
   3  src/flask/testing.py
      name matches · connected to other matches
      read first: lines 135-183 (session_transaction), 193-202 (_request_from_builder_args)

The same result is written to .mimry/mimry-out/context/latest.md as a context pack for the agent, with the matched symbols, related files and the project's test commands.

Prompt hook: Name the files for each task. Token savings: See the tokens MIMRY saved.

Features

  • Ranked lookup. Ranks files and names the lines to read first in each.
  • Code graph. Parses 41 languages with tree-sitter.
  • Deterministic. Same code, same results on every machine (how).
  • Documents. Indexes Markdown, PDF, Word, Excel and PowerPoint.
  • Incremental. Re-reads only the files that changed.
  • Feedback. Ranks files that helped on similar tasks higher.
  • MCP server. Exposes every lookup as an MCP tool.
  • Local. No LLM, API key or telemetry.

Supported languages

MIMRY parses these with tree-sitter.

Area File types What MIMRY reads
Programming .py, .js, .ts, .go, .java and more Symbols, imports, calls
Stylesheets .css, .scss Selectors, variables, mixins
Markup .html, .vue, .svelte Element ids and components
SQL .sql Tables and the objects that use them
Data .json, .yaml, .toml, .xml, .tf Keys and names, never values
Build files .gradle, package.json, pyproject.toml Tasks, commands, entry points
Documents .md, .pdf, .docx, .xlsx, .pptx Headings, pages, sheets, slides

Every extension is in docs/languages.md.

Supported agents

mimry install --platform <name> installs a skill that teaches the agent when to use MIMRY, and registers the MCP server where the agent supports it.

Agent Platform name Skill MCP server
Claude Code claude-code ✅ ✅
Codex codex ✅ ✅
GitHub Copilot CLI copilot ✅ ✅
GitHub Copilot in VS Code vscode ✅ ✅
Gemini CLI gemini ✅ ✅
OpenCode opencode ✅ ✅
Kiro kiro ✅ ✅
Cursor cursor ✅ ✅
Amp amp ✅ ✅
Devin devin ✅ ✅
Factory Droid droid ✅ ✅
Kimi kimi ✅ ✅
Kilo Code kilo ✅ manual
Antigravity, CodeBuddy, Hermes, OpenClaw, Trae see mimry install --list-platforms ✅ manual
Trae CN trae-cn ✅ manual
Aider, Pi Agent see mimry install --list-platforms ✅ none
Agent Skills agents ✅ none
Windsurf windsurf ✅ manual
Cline cline ✅ manual
Roo Code roo ✅ manual
Zed zed ✅ ✅, or printed to paste in when its settings file has comments
JetBrains Junie junie ✅ ✅
Grok Build grok ✅ not yet

✅ means mimry install sets it up, and manual means you add the MCP server by hand. none means the agent has no MCP support, so the skill alone covers it. not yet means mimry install does not register an MCP server for the agent yet.

Each agent's files, the install options and manual MCP setup are in docs/agents.md.

Usage

mimry preflight "<task>"            # list the files and lines to read first, and write a context pack
mimry find "<query>"                # rank files for a query
mimry symbol <name>                 # find where a function, class or heading is defined
mimry callers <name>                # list the functions that call a function, from the graph
mimry callees <name>                # list the functions a function calls, from the graph
mimry related "<query>"             # list files connected through imports and calls
mimry explain "<task>"              # show the key files and symbols, and how they connect
mimry why <file> --query "<task>"   # explain why a file ranked
mimry feedback ...                  # record which files helped
mimry status                        # check whether the index is current
mimry doctor                        # diagnose the install and the index

See docs/commands.md for every command and option. When something misbehaves, see docs/troubleshooting.md.

Configuration

A mimry.toml at the repository root controls which files are indexed. Commit it so everyone on the team gets the same index. The options and examples are in docs/configuration.md.

Benchmarks

These numbers come from a scripted retrieval benchmark, not from complete agent sessions. Measured with MIMRY 0.9.0 on 44 merged pull requests from 6 open-source projects, the set rerun for every release:

How the agent reads files Tokens saved with MIMRY Tasks located, MIMRY / grep
The line ranges MIMRY names first 71.4% 32 / 28
Whole files 51.0% 33 / 28
grep -n, then 100 lines around each match 48.6% 31 / 27

Method, SWE-bench results and a worked example: docs/benchmarks.md.

How it works

MIMRY parses each file into symbols and edges, ranks files against a task, and re-reads only the files that changed. The three steps are described in docs/how-it-works.md.

Privacy

Indexing and search run locally. Credential files are skipped. The details, including how secrets are redacted, are in docs/privacy.md.

Contributing

Bug reports and pull requests are welcome. See CONTRIBUTING.md for setup and checks. MIMRY is in public alpha, and its interfaces may change before 1.0.

Thanks to everyone who has contributed:

MIMRY contributors

License

MIT

Metadata

Release files for mimry 0.9.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for mimry 0.9.0
File Size Uploaded Provenance Actions
mimry-0.9.0.tar.gz 1.9 MB With provenance Details for mimry-0.9.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for mimry 0.9.0
File Interpreter ABI Platform Actions
mimry-0.9.0-py3-none-any.whl Python 3 none any Details for mimry-0.9.0-py3-none-any.whl

Total release size: 2.4 MB

Release files / mimry-0.9.0.tar.gz

Download URL mimry-0.9.0.tar.gz
Size 1.9 MB
Tags Source
SHA-256 checksum
How to use checksums
28f53f63bc1ebf2a1e761df698ed17b390965f4c9333e68f8093c444e370b351
BLAKE2b-256 checksum
How to use checksums
5d6a839753e44ecb835c9297a52af799d66ba7d3508ecec1ce2968fb67d4e1ec
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 5, 2026.

Transparency log

Release files / mimry-0.9.0-py3-none-any.whl

Download URL mimry-0.9.0-py3-none-any.whl
Size 506.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
6b72046ed2f5161db06a7dc5ae0898006537cf17406956d6e85c4696fcf5d046
BLAKE2b-256 checksum
How to use checksums
c30dc3cfce7b13f2e7faf15d443fe70a72bad4bd2ec6a5fa21cd826cfcbbfddf
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 5, 2026.

Transparency log

Security for mimry 0.9.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Full provenance

Both files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for mimry-0.9.0.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 5, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page