Skip to main content

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_docs tool)
  • List indexed files (the list_indexed_files tool)
  • Index new documents from conversation (the index_document tool)

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


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

markdex-0.1.0.tar.gz (10.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

markdex-0.1.0-py3-none-any.whl (9.6 kB view details)

Uploaded Python 3

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

Hashes for markdex-0.1.0.tar.gz
Algorithm Hash digest
SHA256 1d86ac0a1dd8960c26b4d89665a54a1da8a6271f5f70165143f561b916f0b2be
MD5 ac4101375a156ebc2d9819c2db64b8d3
BLAKE2b-256 d5f0f33ad396cb02cd4bca6d6cacfedb099f51bcc2e6453aac94c526a61fbac4

See more details on using hashes here.

Provenance

The following attestation bundles were made for markdex-0.1.0.tar.gz:

Publisher: publish.yml on j-ronk/markdex

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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

Hashes for markdex-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 876011c9912206eaa5801513fd61b8dae33b82f8d3ed466f7aab6a3d69d37134
MD5 343c1c869e34e0f15c39d58c07dcb80f
BLAKE2b-256 68ba4d275f3f27bf97dd26c5bf577ed3c67daaf37819bfa5cf9e07838c6cd675

See more details on using hashes here.

Provenance

The following attestation bundles were made for markdex-0.1.0-py3-none-any.whl:

Publisher: publish.yml on j-ronk/markdex

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page