repo-reader-mcp 0.1.0__tar.gz

repo_reader_mcp-0.1.0/.gitignore

@@ -0,0 +1,226 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#   Usually these files are written by a python script from a template
+#   before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+*.lcov
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+# Pipfile.lock
+
+# uv
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+# uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+# poetry.lock
+# poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+# pdm.lock
+# pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+# pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi/*
+!.pixi/config.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule*
+celerybeat.pid
+
+# Redis
+*.rdb
+*.aof
+*.pid
+
+# RabbitMQ
+mnesia/
+rabbitmq/
+rabbitmq-data/
+
+# ActiveMQ
+activemq-data/
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs/Zensical documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#   JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#   be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#   and can be added to the global gitignore or merged into this file.  For a more nuclear
+#   option (not recommended) you can uncomment the following to ignore the entire idea folder.
+# .idea/
+
+# Abstra
+#   Abstra is an AI-powered process automation framework.
+#   Ignore directories containing user credentials, local state, and settings.
+#   Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#   Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore that
+#   can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#   and can be added to the global gitignore or merged into this file. However, if you prefer, you
+#   could uncomment the following to ignore the entire vscode folder
+# .vscode/
+# Temporary file for partial code execution
+tempCodeRunnerFile.py
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Streamlit
+.streamlit/secrets.toml
+
+# The docs site: dependencies, the build, and the pages sync-docs makes from docs/
+website/node_modules/
+website/dist/
+website/.astro/
+website/src/content/docs/

repo_reader_mcp-0.1.0/CHANGELOG.md

@@ -0,0 +1,23 @@
+# Changelog
+
+One line per change, newest on top: `YYYY-MM-DD — what was done`.
+
+---
+
+2026-10-24 — the site's landing page on the pattern of detectkit's: a hero with a real agent-and-server exchange, sections showing what the tools actually print (history, search, mirrors and groups, safety, guidance, clients), "what it is — and isn't"; light and dark; made-up data only; milestone 5 done
+2026-10-24 — 0.1.0, the first release: the package on PyPI (`uvx repo-reader-mcp`, `pip install repo-reader-mcp`), published by trusted publishing from the `publish` workflow on a tag `v*` (tests run first, the tag must name the version); the guide installs it with `uvx`; README links absolute for PyPI
+2026-10-24 — the third refuting review's findings closed (search and secrets): a regex could read a secret out a character at a time — a line holding a hidden value now never matches a regex, a plain text only clear of it, the answer as git would have given it without the dropped lines; log by message the same; keys on one line, in diffs and Redis-style URL passwords hidden; a marker in code no longer hides what follows; credential files and log no longer walk whole trees and histories; more credential names; answers kept within their limit; milestone 4 done
+2026-10-24 — secrets found in files hidden in every answer and error (providers' token formats, URL passwords, private keys — a block whole where the file is at hand —, values of settings named for secrets, passwords in prose), the count said; a guessed secret can't be confirmed by search, grep or a log by message; files named for credentials (`.env`, `*.pem`, `id_rsa`, …) never served nor fetched unless `serve_credential_files: true`
+2026-10-24 — `search` across repositories (default branches) and `grep` in one at any ref, with context or files only: `git grep` given the served files by name, so nothing include / exclude keep out is ever searched; 0.2–0.4 s over 18 real repositories; real Claude Code answered a cross-repository question with it
+2026-10-24 — the docs site is live at https://repo-reader.pipelab.dev (pipelab's `repo-reader-web`), redeployed on every push to main; milestone 3 done
+2026-10-24 — missing contents of a partial clone recognised as newer git (2.44+, CI's) reports them
+2026-10-24 — the docs site: `website/` (Astro + Starlight) built from `docs/` and the changelog — every page of the guide on it, held by a test; an nginx image pushed to GHCR by the `website` workflow, which asks pipelab to redeploy
+2026-10-24 — groups leave forks out unless `forks: true`; two repositories of a group sharing a name (GitLab's subgroups) are both served, named by their path below the owner
+2026-10-24 — groups of repositories (`github: owner/pattern`, `gitlab: group/**/pattern`, `skip`, `host`) listed by the host's API before every sync — new ones join, archived ones leave, the last listing kept on disk; Streamable HTTP (`--http`, stateless, JSON answers) behind a bearer token or a gateway; links to the host's pages in answers (GitHub, GitLab, Bitbucket, `links:`); a second refuting review's 10 findings closed; 236 tests, 59 protections each failing its test when removed; real Claude Code and the MCP Inspector answering over HTTP through an 18-repository public GitHub group; the guide's groups section and team page; milestone 2 done
+2026-10-24 — remote repositories mirrored from any git URL: bare partial clones in the server's cache folder, a token by variable name in git's environment only (to its host only, no redirect followed), a sync at start and every `mirrors.every_minutes` that follows force-pushes, `refs` to narrow what is kept, contents fetched only for served paths (on purpose before a tool needs an older one), blame following renames as far as served files allow, `--sync`; every reading command pinned off the network whatever the machine's git configuration says, no attributes or mailmap read from a commit, no hooks; a mirror per configuration; a refuting review's 11 findings closed (one a diff leak since milestone 1); 187 tests, 33 protections each failing its test when removed; real Claude Code answering through a mirrored public GitHub repository; the guide's remote-repositories page
+2026-10-24 — commit dates shown the same whatever git's version (newer git writes UTC as `Z`; CI caught it)
+2026-10-24 — repositories' guidance for agents: `AGENTS.md` / `CLAUDE.md` / `.claude/rules` / `.cursor/rules` / skills found on the default branch, text and files from the configuration, `from` another repository, `listed: false`; every answer about a repository says it has guidance (MCP keeps no session), short scoped rules ride with answers about their paths; `read_guidance`; `--check` lists it and warns; a history leaves out commits that changed only what is not served; real Claude Code followed guidance it could not have guessed; milestone 1 done
+2026-10-24 — milestone 1's reading: the YAML configuration and its check (`--check`), eight read-only tools over local repositories (`list_repos`, `list_refs`, `read_file`, `list_files`, `log`, `show_commit`, `diff`, `blame`), include / exclude, every git output capped; 108 tests on made-up repositories, every protection failing its test when removed; a refuting review (blame's ignore-revs file closed); real Claude Code answering over stdio; the guide's tools, configuration, safety and getting-started pages; remote repositories now milestone 2, groups planned
+2026-10-24 — ready to start: the guide's rule with a test (every tool in `docs/reference/tools.md`), `/close` checks the guide; the site moved to milestone 2; the hosting (pipelab) and where a company's requirements come from written in `CLAUDE.md`; context and parallel-work rules
+2026-10-24 — `docs/` is the public documentation's source (a site to come, Astro + Starlight like detectkit's, hosted through pipelab); design, plan, decisions, research moved to `dev/`
+2026-10-24 — groundwork: the repository, README, design, plan, decisions, research, the session flow; a skeleton server (stdio, `about`) with tests, ruff and CI

repo_reader_mcp-0.1.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

repo_reader_mcp-0.1.0/PKG-INFO

@@ -0,0 +1,93 @@
+Metadata-Version: 2.5
+Name: repo-reader-mcp
+Version: 0.1.0
+Summary: A read-only MCP server for code in git repositories — files, branches, history, diffs, blame and search — for any MCP client and any code host.
+Project-URL: Homepage, https://repo-reader.pipelab.dev
+Project-URL: Documentation, https://repo-reader.pipelab.dev/getting-started/
+Project-URL: Repository, https://github.com/alexeiveselov92/repo-reader-mcp
+Project-URL: Changelog, https://github.com/alexeiveselov92/repo-reader-mcp/blob/main/CHANGELOG.md
+Project-URL: Issues, https://github.com/alexeiveselov92/repo-reader-mcp/issues
+Author: Aleksei Veselov
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: ai-agents,code-search,git,mcp,model-context-protocol
+Classifier: Development Status :: 2 - Pre-Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: POSIX
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Version Control :: Git
+Requires-Python: >=3.12
+Requires-Dist: mcp<3,>=2.3
+Requires-Dist: pydantic>=2.7
+Requires-Dist: pyyaml>=6
+Description-Content-Type: text/markdown
+
+# repo-reader-mcp
+
+A read-only [MCP](https://modelcontextprotocol.io) server that lets any AI agent read and search code
+in git repositories — files at any branch, tag or commit, the history, diffs, blame and search across
+many repositories — without ever changing them.
+
+> **Status: pre-alpha.** It reads local repositories, and remote ones it mirrors from any git host — one by one, or a
+> whole group by a pattern (`github: acme/shop-*`) — at any branch, tag or commit: history, diffs, blame. One server
+> can serve a team over HTTP behind a token, and search across all its repositories at once; secrets found in files are
+> hidden. Documentation: **[repo-reader.pipelab.dev](https://repo-reader.pipelab.dev)**. The plan is in [dev/PLAN.md](https://github.com/alexeiveselov92/repo-reader-mcp/blob/main/dev/PLAN.md), the design in [dev/DESIGN.md](https://github.com/alexeiveselov92/repo-reader-mcp/blob/main/dev/DESIGN.md).
+
+## Install
+
+```bash
+uvx repo-reader-mcp --config config.yaml --check   # with uv: nothing else to install
+pip install repo-reader-mcp                          # or into an environment of your own
+```
+
+Python 3.12+ and git 2.31+. Then [say which repositories it reads and connect your agent](https://repo-reader.pipelab.dev/getting-started/).
+
+## Why
+
+Agents answer questions about code better when they can read it the way a developer does: open a file
+at the commit that matters, follow a change through the history, compare a branch with `main`, see who
+wrote a line and why. Most git MCP servers work on one local checkout and can write to it. This one is
+built to be pointed at many repositories — local folders or remote hosts — and to be safe to hand to a
+whole team.
+
+## What it will do
+
+- **Read** a file, a folder, any branch, tag or commit — not only the default branch.
+- **History**: commits of a repository or a path, a commit with its diff, a diff between two refs, blame.
+- **Guidance for agents**: a repository's `AGENTS.md`, `CLAUDE.md`, rules and skills reach the agent reading it
+  — plus what the people who run the server add, from its configuration or from another repository.
+- **Search** across all configured repositories at once, and `grep` inside one at any ref, with lines of context.
+- **Any code host**: local paths, GitHub, GitLab, Bitbucket, any git server — mirrored on a schedule,
+  fetching only what is served; a group of repositories named by a pattern, new ones joining as they are created.
+- **Read-only by construction**: no command that writes, no shell; secrets found in files are hidden
+  before an agent sees them; answers sized for what clients accept.
+- **Any MCP client**: stdio for a local agent, Streamable HTTP for a shared server — Claude, ChatGPT,
+  Cursor, Codex, any client that speaks MCP.
+
+## Configuration
+
+One YAML file names the repositories and what to take from them; secrets are named, never written in it.
+An example is in [examples/config.example.yaml](https://github.com/alexeiveselov92/repo-reader-mcp/blob/main/examples/config.example.yaml); every key is in
+[docs/reference/configuration.md](https://github.com/alexeiveselov92/repo-reader-mcp/blob/main/docs/reference/configuration.md). The documentation is at
+**[repo-reader.pipelab.dev](https://repo-reader.pipelab.dev)**, built from [docs/](https://github.com/alexeiveselov92/repo-reader-mcp/blob/main/docs/README.md).
+
+## Development
+
+Python 3.12, [uv](https://docs.astral.sh/uv/), the official [MCP Python SDK](https://github.com/modelcontextprotocol/python-sdk).
+
+```bash
+uv sync
+uv run pytest
+uv run ruff check . && uv run ruff format --check .
+uv run repo-reader-mcp --config my-config.yaml --check                 # check a configuration
+uv run repo-reader-mcp --config my-config.yaml --sync                  # bring the mirrors up to date once
+uv run repo-reader-mcp --config my-config.yaml                         # the server over stdio
+uv run repo-reader-mcp --config my-config.yaml --http 127.0.0.1:8000   # over Streamable HTTP, at /mcp
+```
+
+## License
+
+[Apache-2.0](https://github.com/alexeiveselov92/repo-reader-mcp/blob/main/LICENSE).

repo_reader_mcp-0.1.0/README.md

@@ -0,0 +1,66 @@
+# repo-reader-mcp
+
+A read-only [MCP](https://modelcontextprotocol.io) server that lets any AI agent read and search code
+in git repositories — files at any branch, tag or commit, the history, diffs, blame and search across
+many repositories — without ever changing them.
+
+> **Status: pre-alpha.** It reads local repositories, and remote ones it mirrors from any git host — one by one, or a
+> whole group by a pattern (`github: acme/shop-*`) — at any branch, tag or commit: history, diffs, blame. One server
+> can serve a team over HTTP behind a token, and search across all its repositories at once; secrets found in files are
+> hidden. Documentation: **[repo-reader.pipelab.dev](https://repo-reader.pipelab.dev)**. The plan is in [dev/PLAN.md](https://github.com/alexeiveselov92/repo-reader-mcp/blob/main/dev/PLAN.md), the design in [dev/DESIGN.md](https://github.com/alexeiveselov92/repo-reader-mcp/blob/main/dev/DESIGN.md).
+
+## Install
+
+```bash
+uvx repo-reader-mcp --config config.yaml --check   # with uv: nothing else to install
+pip install repo-reader-mcp                          # or into an environment of your own
+```
+
+Python 3.12+ and git 2.31+. Then [say which repositories it reads and connect your agent](https://repo-reader.pipelab.dev/getting-started/).
+
+## Why
+
+Agents answer questions about code better when they can read it the way a developer does: open a file
+at the commit that matters, follow a change through the history, compare a branch with `main`, see who
+wrote a line and why. Most git MCP servers work on one local checkout and can write to it. This one is
+built to be pointed at many repositories — local folders or remote hosts — and to be safe to hand to a
+whole team.
+
+## What it will do
+
+- **Read** a file, a folder, any branch, tag or commit — not only the default branch.
+- **History**: commits of a repository or a path, a commit with its diff, a diff between two refs, blame.
+- **Guidance for agents**: a repository's `AGENTS.md`, `CLAUDE.md`, rules and skills reach the agent reading it
+  — plus what the people who run the server add, from its configuration or from another repository.
+- **Search** across all configured repositories at once, and `grep` inside one at any ref, with lines of context.
+- **Any code host**: local paths, GitHub, GitLab, Bitbucket, any git server — mirrored on a schedule,
+  fetching only what is served; a group of repositories named by a pattern, new ones joining as they are created.
+- **Read-only by construction**: no command that writes, no shell; secrets found in files are hidden
+  before an agent sees them; answers sized for what clients accept.
+- **Any MCP client**: stdio for a local agent, Streamable HTTP for a shared server — Claude, ChatGPT,
+  Cursor, Codex, any client that speaks MCP.
+
+## Configuration
+
+One YAML file names the repositories and what to take from them; secrets are named, never written in it.
+An example is in [examples/config.example.yaml](https://github.com/alexeiveselov92/repo-reader-mcp/blob/main/examples/config.example.yaml); every key is in
+[docs/reference/configuration.md](https://github.com/alexeiveselov92/repo-reader-mcp/blob/main/docs/reference/configuration.md). The documentation is at
+**[repo-reader.pipelab.dev](https://repo-reader.pipelab.dev)**, built from [docs/](https://github.com/alexeiveselov92/repo-reader-mcp/blob/main/docs/README.md).
+
+## Development
+
+Python 3.12, [uv](https://docs.astral.sh/uv/), the official [MCP Python SDK](https://github.com/modelcontextprotocol/python-sdk).
+
+```bash
+uv sync
+uv run pytest
+uv run ruff check . && uv run ruff format --check .
+uv run repo-reader-mcp --config my-config.yaml --check                 # check a configuration
+uv run repo-reader-mcp --config my-config.yaml --sync                  # bring the mirrors up to date once
+uv run repo-reader-mcp --config my-config.yaml                         # the server over stdio
+uv run repo-reader-mcp --config my-config.yaml --http 127.0.0.1:8000   # over Streamable HTTP, at /mcp
+```
+
+## License
+
+[Apache-2.0](https://github.com/alexeiveselov92/repo-reader-mcp/blob/main/LICENSE).

repo_reader_mcp-0.1.0/docs/README.md

@@ -0,0 +1,28 @@
+# repo-reader-mcp documentation
+
+The documentation for people who use and run repo-reader-mcp. This folder is the **single source**: the site
+(Astro + Starlight, in `website/`, at [repo-reader.pipelab.dev](https://repo-reader.pipelab.dev)) is built from these
+files and carries every one of them — a test fails otherwise; edit them here, never in the site.
+
+How the project is built and planned is not here: that is `dev/` (design, plan, decisions, research).
+
+## Pages
+
+- [Getting started](getting-started.md) — run it from a clone, say which repositories it reads, connect it to an agent,
+  ask.
+- [Remote repositories](remote-repositories.md) — repositories on GitHub, GitLab or any git server: mirrors, what they
+  hold, how they stay fresh, groups of repositories by a pattern, tokens per host.
+- [Running it for a team](serving-over-http.md) — one shared server over Streamable HTTP: a bearer token or a gateway,
+  connecting agents.
+- **Reference**
+  - [Tools](reference/tools.md) — every tool, its inputs and its answer.
+  - [Configuration](reference/configuration.md) — the file, every key, the patterns of `include` / `exclude`, limits.
+  - [Guidance for agents](reference/guidance.md) — the rules a repository carries for agents (`AGENTS.md`,
+    `CLAUDE.md`, rules, skills) and what the configuration adds; how they reach an agent.
+  - [Safety](reference/safety.md) — what it never does, and what it doesn't do yet.
+
+Planned, each written with the change that makes it true: search and grep; a container image; a contributing page.
+
+Three readers: people who use it through their agent (getting started, guides), people who run it (guides,
+reference), people who contribute (a contributing page). A page is written in the same commit as the change that makes
+it true; a tool without its reference entry fails the tests.