Local Markdown indexing and retrieval via MCP
Project description
markdex
Local Markdown indexing and retrieval via MCP. Index your Markdown documents and query them from Claude Code using semantic search.
Install
git clone <repo-url>
cd markdex
pipx install -e . --python python3.13
This puts markdex on your PATH globally via an isolated venv. Requires pipx (brew install pipx). Use Python 3.13 or earlier (chromadb doesn't yet support 3.14).
Quick Start
Index your documents:
markdex index path/to/docs/
Check what's indexed:
markdex list
Claude Code Integration
Add markdex as a global MCP server:
claude mcp add --scope user --transport stdio markdex -- markdex serve
Then in any Claude Code session, you can:
- Search your indexed docs (the
query_docstool) - List indexed files (the
list_indexed_filestool) - Index new documents from conversation (the
index_documenttool)
Commands
| Command | Description |
|---|---|
markdex index <path> [--reset] |
Index .md files from a file or directory |
markdex serve |
Start the MCP server (stdio transport) |
markdex list |
List all indexed files |
Data Storage
All data is stored in ~/.markdex/:
chroma_db/— vector store (ChromaDB)
Development
pip install -e ".[dev]"
pytest tests/ -v
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file markdex-0.1.0.tar.gz.
File metadata
- Download URL: markdex-0.1.0.tar.gz
- Upload date:
- Size: 10.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
1d86ac0a1dd8960c26b4d89665a54a1da8a6271f5f70165143f561b916f0b2be
|
|
| MD5 |
ac4101375a156ebc2d9819c2db64b8d3
|
|
| BLAKE2b-256 |
d5f0f33ad396cb02cd4bca6d6cacfedb099f51bcc2e6453aac94c526a61fbac4
|
Provenance
The following attestation bundles were made for markdex-0.1.0.tar.gz:
Publisher:
publish.yml on j-ronk/markdex
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
markdex-0.1.0.tar.gz -
Subject digest:
1d86ac0a1dd8960c26b4d89665a54a1da8a6271f5f70165143f561b916f0b2be - Sigstore transparency entry: 991668591
- Sigstore integration time:
-
Permalink:
j-ronk/markdex@6445915ee83fa65416d3559b10627ed35520d444 -
Branch / Tag:
refs/tags/v0.1.0 - Owner: https://github.com/j-ronk
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@6445915ee83fa65416d3559b10627ed35520d444 -
Trigger Event:
release
-
Statement type:
File details
Details for the file markdex-0.1.0-py3-none-any.whl.
File metadata
- Download URL: markdex-0.1.0-py3-none-any.whl
- Upload date:
- Size: 9.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
876011c9912206eaa5801513fd61b8dae33b82f8d3ed466f7aab6a3d69d37134
|
|
| MD5 |
343c1c869e34e0f15c39d58c07dcb80f
|
|
| BLAKE2b-256 |
68ba4d275f3f27bf97dd26c5bf577ed3c67daaf37819bfa5cf9e07838c6cd675
|
Provenance
The following attestation bundles were made for markdex-0.1.0-py3-none-any.whl:
Publisher:
publish.yml on j-ronk/markdex
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
markdex-0.1.0-py3-none-any.whl -
Subject digest:
876011c9912206eaa5801513fd61b8dae33b82f8d3ed466f7aab6a3d69d37134 - Sigstore transparency entry: 991668598
- Sigstore integration time:
-
Permalink:
j-ronk/markdex@6445915ee83fa65416d3559b10627ed35520d444 -
Branch / Tag:
refs/tags/v0.1.0 - Owner: https://github.com/j-ronk
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@6445915ee83fa65416d3559b10627ed35520d444 -
Trigger Event:
release
-
Statement type: