Skip to main content

A Python package for accessing Solr indexes via Model Context Protocol (MCP)

Project description

Solr MCP

A Python package for accessing Apache Solr indexes via Model Context Protocol (MCP). This integration allows AI assistants like Claude to perform powerful search queries against your Solr indexes, combining both keyword and vector search capabilities.

Features

  • MCP Server: Implements the Model Context Protocol for integration with AI assistants
  • Hybrid Search: Combines keyword search precision with vector search semantic understanding
  • Vector Embeddings: Generates embeddings for documents using Ollama with nomic-embed-text
  • Unified Collections: Store both document content and vector embeddings in the same collection
  • Docker Integration: Easy setup with Docker and docker-compose
  • Optimized Vector Search: Efficiently handles combined vector and SQL queries by pushing down SQL filters to the vector search stage, ensuring optimal performance even with large result sets and pagination

Architecture

Vector Search Optimization

The system employs an important optimization for combined vector and SQL queries. When executing a query that includes both vector similarity search and SQL filters:

  1. SQL filters (WHERE clauses) are pushed down to the vector search stage
  2. This ensures that vector similarity calculations are only performed on documents that will match the final SQL criteria
  3. Significantly improves performance for queries with:
    • Selective WHERE clauses
    • Pagination (LIMIT/OFFSET)
    • Large result sets

This optimization reduces computational overhead and network transfer by minimizing the number of vector similarity calculations needed.

Quick Start

  1. Clone this repository
  2. Start SolrCloud with Docker:
    docker-compose up -d
    
  3. Install dependencies:
    python -m venv venv
    source venv/bin/activate  # On Windows: venv\Scripts\activate
    pip install poetry
    poetry install
    
  4. Process and index the sample document:
    python scripts/process_markdown.py data/bitcoin-whitepaper.md --output data/processed/bitcoin_sections.json
    python scripts/create_unified_collection.py unified
    python scripts/unified_index.py data/processed/bitcoin_sections.json --collection unified
    
  5. Run the MCP server:
    poetry run python -m solr_mcp.server
    

For more detailed setup and usage instructions, see the QUICKSTART.md guide.

Requirements

  • Python 3.10 or higher
  • Docker and Docker Compose
  • SolrCloud 9.x
  • Ollama (for embedding generation)

License

This project is licensed under the MIT License - see the LICENSE file for details.

Contributing

Contributions are welcome! Please see CONTRIBUTING.md for guidelines.

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

iflow_mcp_solr_mcp-0.1.0.tar.gz (35.8 kB view details)

Uploaded Source

Built Distribution

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

iflow_mcp_solr_mcp-0.1.0-py3-none-any.whl (51.5 kB view details)

Uploaded Python 3

File details

Details for the file iflow_mcp_solr_mcp-0.1.0.tar.gz.

File metadata

  • Download URL: iflow_mcp_solr_mcp-0.1.0.tar.gz
  • Upload date:
  • Size: 35.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.9.10 {"installer":{"name":"uv","version":"0.9.10"},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for iflow_mcp_solr_mcp-0.1.0.tar.gz
Algorithm Hash digest
SHA256 e46176633695a24f18908f2c7b0c7821953f2fb3cb5eddeca8ea8c6a228352b8
MD5 a99e08a8db251183966df0846b36bc3d
BLAKE2b-256 e53aa81a11e230f6843abcdd87ffd973a64657910502f9910262537f171d5f0a

See more details on using hashes here.

File details

Details for the file iflow_mcp_solr_mcp-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: iflow_mcp_solr_mcp-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 51.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.9.10 {"installer":{"name":"uv","version":"0.9.10"},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for iflow_mcp_solr_mcp-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ab7971c8624403b076c87649e397db8c8adbab291cc9f5772a18e520d993ed92
MD5 a49136bd28bf581c54868d636d05cac1
BLAKE2b-256 8830e54f627d07185978ef56c6b175e4f48e64808c187a41234d4f5b14d5f99d

See more details on using hashes here.

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