Metadata-Version: 2.4
Name: mcp-server-qdrant-pro
Version: 0.1.6
Summary: MCP server for Qdrant vector database - supports personal memory management and enterprise GitHub codebase search. Extended from original mcp-server-qdrant package
License-Expression: Apache-2.0
License-File: LICENSE
Keywords: mcp,memory,qdrant,rag,vector-database
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.10
Requires-Dist: fastembed>=0.6.0
Requires-Dist: fastmcp>=2.7.0
Requires-Dist: pydantic>=2.10.6
Requires-Dist: qdrant-client>=1.12.0
Requires-Dist: voyageai>=0.2.0
Description-Content-Type: text/markdown

# mcp-server-qdrant: A Qdrant MCP server

[![smithery badge](https://smithery.ai/badge/mcp-server-qdrant)](https://smithery.ai/protocol/mcp-server-qdrant)

> The [Model Context Protocol (MCP)](https://modelcontextprotocol.io/introduction) is an open protocol that enables
> seamless integration between LLM applications and external data sources and tools. Whether you're building an
> AI-powered IDE, enhancing a chat interface, or creating custom AI workflows, MCP provides a standardized way to
> connect LLMs with the context they need.

This repository is an example of how to create a MCP server for [Qdrant](https://qdrant.tech/), a vector search engine.

## Overview

A Model Context Protocol server for advanced GitHub codebase search using Qdrant vector search engine.
It provides semantic code search capabilities across vectorized GitHub repositories.

### Features
- **Repository-scoped search**: Always filtered by repository for focused results
- **Semantic code search**: Find functionality patterns across codebases
- **Code pattern analysis**: Understand repository structure and common patterns
- **Implementation discovery**: Find examples of specific functionality
- **Rich metadata filtering**: Filter by programming language, themes, complexity, file types, and more
- **Hierarchical filtering**: Repository → themes → refinement filters for optimal search experience



## Components

### Tools

1. `qdrant-search-repository`
   - Search for code patterns and implementations within a specific GitHub repository.
   - Input:
     - `repository_id` (string, required): Repository identifier in format 'owner/repo' (e.g., 'taika-st/dtna-chat').
     - `query` (string): Semantic search query for finding code patterns, functionality, or implementations.
     - `themes` (string, optional): JSON array string of code themes/patterns (e.g., `'["authentication", "database"]'`). See "Themes full-text search" below for semantics.
     - `programming_language` (string, optional): Filter by programming language.
     - `complexity_score` (integer, optional): Minimum complexity score.
     - Additional filterable fields: `file_type`, `directory`, `has_code_patterns`, etc.
   - Returns: Formatted code snippets with rich metadata.

2. `qdrant-analyze-patterns`
   - Analyze code patterns, themes, and architecture within a repository.
   - Input:
     - `repository_id` (string, required): Repository identifier.
     - `themes` (string, optional): JSON array string of specific themes to analyze.
     - `programming_language` (string, optional): Focus on specific language.
     - `directory` (string, optional): Analyze specific directory.
   - Returns: Repository analysis with statistics and insights.

3. `qdrant-find-implementations`
   - Find implementations of specific patterns or functionality within a repository.
   - Input:
     - `repository_id` (string, required): Repository identifier.
     - `pattern_query` (string): Description of pattern to find (e.g., 'user authentication', 'database connection').
     - `themes` (string, optional): JSON array string of expected themes for filtering.
     - `programming_language` (string, optional): Expected programming language.
     - `min_complexity` (integer, optional): Minimum complexity threshold.
   - Returns: Implementations ranked by semantic similarity.

#### Themes full-text search
- `themes` is a full-text searchable field. Provided values are matched using OR semantics and support partial matches (e.g., `"auth"` matches `"authentication"`).
- Entries missing `metadata.themes` are not excluded by a `themes` filter (soft preference via Filter.should).
- The tools expect `themes` as a JSON array string and parse it internally into a list.

#### Automatic payload index creation
- The server ensures required payload indexes (including TEXT for `metadata.themes`) exist before querying.
- Existing collections are upgraded automatically and idempotently on first use.
- If your Qdrant cluster is configured as read-only, temporarily allow writes to create indexes or pre-create them.

## Environment Variables

The configuration of the server is done using environment variables:

| Name                                        | Description                                                         | Default Value                                                     |
|---------------------------------------------|---------------------------------------------------------------------|-------------------------------------------------------------------|
| `QDRANT_URL`                                | URL of the Qdrant server                                            | None                                                              |
| `QDRANT_API_KEY`                            | API key for the Qdrant server                                       | None                                                              |
| `COLLECTION_NAME`                           | Name of the collection containing vectorized GitHub repositories    | None                                                              |
| `QDRANT_LOCAL_PATH`                         | Path to the local Qdrant database (alternative to `QDRANT_URL`)     | None                                                              |
| `QDRANT_SEARCH_LIMIT`                       | Maximum results per search operation                                 | `10`                                                              |
| `QDRANT_READ_ONLY`                          | If `true`, the server will not attempt to create or modify indexes    | `false`                                                           |
| `QDRANT_ALLOW_ARBITRARY_FILTER`             | Allow arbitrary filter conditions in queries                        | `false`                                                           |
| `EMBEDDING_PROVIDER`                        | Embedding provider to use (`fastembed` or `voyageai`)              | `fastembed`                                                       |
| `EMBEDDING_MODEL`                           | Name of the embedding model to use                                  | `sentence-transformers/all-MiniLM-L6-v2` (FastEmbed) or `voyage-3.5` (VoyageAI) |
| `VOYAGE_API_KEY`                            | API key for Voyage AI embedding service (required when using `voyageai` provider) | None                                                              |
| `TOOL_SEARCH_REPOSITORY_DESCRIPTION`        | Custom description for the search-repository tool                   | See default in [`settings.py`](src/mcp_server_qdrant/settings.py) |
| `TOOL_ANALYZE_PATTERNS_DESCRIPTION`         | Custom description for the analyze-repository-patterns tool         | See default in [`settings.py`](src/mcp_server_qdrant/settings.py) |
| `TOOL_FIND_IMPLEMENTATIONS_DESCRIPTION`     | Custom description for the find-repository-implementations tool     | See default in [`settings.py`](src/mcp_server_qdrant/settings.py) |

### GitHub Codebase Search Configuration

The server is designed for searching vectorized GitHub repositories. Recommended configuration:

| Setting                  | Recommended Value                                                   | Purpose                                   |
|--------------------------|---------------------------------------------------------------------|-------------------------------------------|
| `COLLECTION_NAME`        | `github-codebases` or similar descriptive name                     | Collection with vectorized repositories   |
| `QDRANT_SEARCH_LIMIT`    | `10-50` depending on use case                                       | Balance between relevance and performance |
| `QDRANT_ALLOW_ARBITRARY_FILTER` | `false` (recommended for security)                             | Restrict to predefined filter fields     |

Note: You cannot provide both `QDRANT_URL` and `QDRANT_LOCAL_PATH` at the same time.

> [!IMPORTANT]
> All server configuration is provided via environment variables. The only supported command-line argument is `--transport` to select the transport protocol.

### FastMCP Environment Variables

Since `mcp-server-qdrant` is based on FastMCP, it also supports all the FastMCP environment variables. The most
important ones are listed below:

| Environment Variable                  | Description                                               | Default Value |
|---------------------------------------|-----------------------------------------------------------|---------------|
| `FASTMCP_DEBUG`                       | Enable debug mode                                         | `false`       |
| `FASTMCP_LOG_LEVEL`                   | Set logging level (DEBUG, INFO, WARNING, ERROR, CRITICAL) | `INFO`        |
| `FASTMCP_HOST`                        | Host address to bind the server to                        | `127.0.0.1`   |
| `FASTMCP_PORT`                        | Port to run the server on                                 | `8000`        |
| `FASTMCP_WARN_ON_DUPLICATE_RESOURCES` | Show warnings for duplicate resources                     | `true`        |
| `FASTMCP_WARN_ON_DUPLICATE_TOOLS`     | Show warnings for duplicate tools                         | `true`        |
| `FASTMCP_WARN_ON_DUPLICATE_PROMPTS`   | Show warnings for duplicate prompts                       | `true`        |
| `FASTMCP_DEPENDENCIES`                | List of dependencies to install in the server environment | `[]`          |

## Installation

### Using uvx

When using [`uvx`](https://docs.astral.sh/uv/guides/tools/#running-tools) no specific installation is needed to directly run the server.

```shell
# Using FastEmbed (default, local embedding)
QDRANT_URL="http://localhost:6333" \
COLLECTION_NAME="my-collection" \
EMBEDDING_MODEL="sentence-transformers/all-MiniLM-L6-v2" \
uvx mcp-server-qdrant-pro
```

### Using VoyageAI Embeddings

For state-of-the-art cloud-based embeddings using VoyageAI:

```shell
# Using VoyageAI (requires API key)
QDRANT_URL="http://localhost:6333" \
COLLECTION_NAME="my-collection" \
EMBEDDING_PROVIDER="voyageai" \
EMBEDDING_MODEL="voyage-3.5" \
VOYAGE_API_KEY="your-voyage-api-key" \
uvx mcp-server-qdrant-pro
```

#### Embedding Provider Options

**FastEmbed (Default)**
- Local embedding models
- No API key required
- No usage costs
- Models: sentence-transformers/* series

**VoyageAI** 
- State-of-the-art cloud embeddings
- Requires API key from [Voyage AI](https://dash.voyageai.com)
- Usage-based pricing
- Specialized models available:
  - `voyage-3.5`: General-purpose (recommended)
  - `voyage-code-3`: Code-optimized  
  - `voyage-law-2`: Legal documents
  - `voyage-finance-2`: Financial documents
  - `voyage-3.5-lite`: Cost-optimized

#### Transport Protocols

The server supports different transport protocols that can be specified using the `--transport` flag:

```shell
QDRANT_URL="http://localhost:6333" \
COLLECTION_NAME="my-collection" \
uvx mcp-server-qdrant-pro --transport sse
```

Supported transport protocols:

- `stdio` (default): Standard input/output transport, might only be used by local MCP clients
- `sse`: Server-Sent Events transport, perfect for remote clients
- `streamable-http`: Streamable HTTP transport, perfect for remote clients, more recent than SSE

The default transport is `stdio` if not specified.

When SSE transport is used, the server will listen on the specified port and wait for incoming connections. The default
port is 8000, however it can be changed using the `FASTMCP_PORT` environment variable.

```shell
QDRANT_URL="http://localhost:6333" \
COLLECTION_NAME="my-collection" \
FASTMCP_PORT=1234 \
uvx mcp-server-qdrant --transport sse
```

### Using Docker

A Dockerfile is available for building and running the MCP server:

```bash
# Build the container
docker build -t mcp-server-qdrant .

# Run the container
docker run -p 8000:8000 \
  -e FASTMCP_HOST="0.0.0.0" \
  -e QDRANT_URL="http://your-qdrant-server:6333" \
  -e QDRANT_API_KEY="your-api-key" \
  -e COLLECTION_NAME="your-collection" \
  mcp-server-qdrant
```

> [!TIP]
> Please note that we set `FASTMCP_HOST="0.0.0.0"` to make the server listen on all network interfaces. This is
> necessary when running the server in a Docker container.

### Installing via Smithery

To install Qdrant MCP Server for Claude Desktop automatically via [Smithery](https://smithery.ai/protocol/mcp-server-qdrant):

```bash
npx @smithery/cli install mcp-server-qdrant --client claude
```

### Manual configuration of Claude Desktop

To use this server with the Claude Desktop app, add the following configuration to the "mcpServers" section of your
`claude_desktop_config.json`:

```json
{
  "qdrant": {
    "command": "uvx",
    "args": ["mcp-server-qdrant-pro"],
    "env": {
      "QDRANT_URL": "https://xyz-example.eu-central.aws.cloud.qdrant.io:6333",
      "QDRANT_API_KEY": "your_api_key",
      "COLLECTION_NAME": "your-collection-name",
      "EMBEDDING_MODEL": "sentence-transformers/all-MiniLM-L6-v2"
    }
  }
}
```

For local Qdrant mode:

```json
{
  "qdrant": {
    "command": "uvx",
    "args": ["mcp-server-qdrant-pro"],
    "env": {
      "QDRANT_LOCAL_PATH": "/path/to/qdrant/database",
      "COLLECTION_NAME": "your-collection-name",
      "EMBEDDING_MODEL": "sentence-transformers/all-MiniLM-L6-v2"
    }
  }
}
```

This MCP server will automatically create a collection with the specified name if it doesn't exist, and ensure required payload indexes are present for filters.

By default, the server will use the `sentence-transformers/all-MiniLM-L6-v2` embedding model to encode memories.
For the time being, only [FastEmbed](https://qdrant.github.io/fastembed/) models are supported.

## Using with MCP-compatible clients

This MCP server can be used with any MCP-compatible client (Claude Desktop, Cursor/Windsurf, VS Code, etc.). The server exposes the following tools:

- `qdrant-search-repository`
- `qdrant-analyze-patterns`
- `qdrant-find-implementations`

### Enterprise GitHub Codebase Search Example
```json
{
  "mcpServers": {
    "qdrant-enterprise": {
      "command": "uvx",
      "args": ["mcp-server-qdrant-pro"],
      "env": {
        "QDRANT_URL": "https://your-qdrant-cluster.com",
        "QDRANT_API_KEY": "your-api-key",
        "COLLECTION_NAME": "github-codebases",
        "QDRANT_SEARCH_LIMIT": "10"
      }
    }
  }
}
```

### Using with Cursor/Windsurf

Configure the MCP server and point your client to the SSE endpoint (recommended for remote connections). For local runs:

```
http://localhost:8000/sse
```

> [!TIP]
> We suggest SSE transport to connect Cursor/Windsurf to the MCP server, as it supports remote connections.

This configuration exposes the enterprise code search tools to your client, enabling repository-scoped semantic search, analysis, and implementation discovery.

**If you have successfully installed the `mcp-server-qdrant`, but still can't get it to work with Cursor, please
consider creating the [Cursor rules](https://docs.cursor.com/context/rules-for-ai) so the MCP tools are always used when
the agent produces a new code snippet.** You can restrict the rules to only work for certain file types, to avoid using
the MCP server for the documentation or other types of content.

### Using with Claude Code

Add the MCP server to Claude Code and connect over SSE. The tools available will be the three enterprise tools described above. You can customize tool descriptions via environment variables:

```bash
export TOOL_SEARCH_REPOSITORY_DESCRIPTION="Custom description for search in your org"
export TOOL_ANALYZE_PATTERNS_DESCRIPTION="Custom description for analysis"
export TOOL_FIND_IMPLEMENTATIONS_DESCRIPTION="Custom description for find implementations"
uvx mcp-server-qdrant-pro --transport sse
```

### Run MCP server in Development Mode

The MCP server can be run in development mode using the `mcp dev` command. This will start the server and open the MCP
inspector in your browser.

```shell
COLLECTION_NAME=mcp-dev fastmcp dev src/mcp_server_qdrant/server.py
```

### Using with VS Code

For one-click installation, click one of the install buttons below:

[![Install with UVX in VS Code](https://img.shields.io/badge/VS_Code-UVX-0098FF?style=flat-square&logo=visualstudiocode&logoColor=white)](https://insiders.vscode.dev/redirect/mcp/install?name=qdrant&config=%7B%22command%22%3A%22uvx%22%2C%22args%22%3A%5B%22mcp-server-qdrant%22%5D%2C%22env%22%3A%7B%22QDRANT_URL%22%3A%22%24%7Binput%3AqdrantUrl%7D%22%2C%22QDRANT_API_KEY%22%3A%22%24%7Binput%3AqdrantApiKey%7D%22%2C%22COLLECTION_NAME%22%3A%22%24%7Binput%3AcollectionName%7D%22%7D%7D&inputs=%5B%7B%22type%22%3A%22promptString%22%2C%22id%22%3A%22qdrantUrl%22%2C%22description%22%3A%22Qdrant+URL%22%7D%2C%7B%22type%22%3A%22promptString%22%2C%22id%22%3A%22qdrantApiKey%22%2C%22description%22%3A%22Qdrant+API+Key%22%2C%22password%22%3Atrue%7D%2C%7B%22type%22%3A%22promptString%22%2C%22id%22%3A%22collectionName%22%2C%22description%22%3A%22Collection+Name%22%7D%5D) [![Install with UVX in VS Code Insiders](https://img.shields.io/badge/VS_Code_Insiders-UVX-24bfa5?style=flat-square&logo=visualstudiocode&logoColor=white)](https://insiders.vscode.dev/redirect/mcp/install?name=qdrant&config=%7B%22command%22%3A%22uvx%22%2C%22args%22%3A%5B%22mcp-server-qdrant%22%5D%2C%22env%22%3A%7B%22QDRANT_URL%22%3A%22%24%7Binput%3AqdrantUrl%7D%22%2C%22QDRANT_API_KEY%22%3A%22%24%7Binput%3AqdrantApiKey%7D%22%2C%22COLLECTION_NAME%22%3A%22%24%7Binput%3AcollectionName%7D%22%7D%7D&inputs=%5B%7B%22type%22%3A%22promptString%22%2C%22id%22%3A%22qdrantUrl%22%2C%22description%22%3A%22Qdrant+URL%22%7D%2C%7B%22type%22%3A%22promptString%22%2C%22id%22%3A%22qdrantApiKey%22%2C%22description%22%3A%22Qdrant+API+Key%22%2C%22password%22%3Atrue%7D%2C%7B%22type%22%3A%22promptString%22%2C%22id%22%3A%22collectionName%22%2C%22description%22%3A%22Collection+Name%22%7D%5D&quality=insiders)

[![Install with Docker in VS Code](https://img.shields.io/badge/VS_Code-Docker-0098FF?style=flat-square&logo=visualstudiocode&logoColor=white)](https://insiders.vscode.dev/redirect/mcp/install?name=qdrant&config=%7B%22command%22%3A%22docker%22%2C%22args%22%3A%5B%22run%22%2C%22-p%22%2C%228000%3A8000%22%2C%22-i%22%2C%22--rm%22%2C%22-e%22%2C%22QDRANT_URL%22%2C%22-e%22%2C%22QDRANT_API_KEY%22%2C%22-e%22%2C%22COLLECTION_NAME%22%2C%22mcp-server-qdrant%22%5D%2C%22env%22%3A%7B%22QDRANT_URL%22%3A%22%24%7Binput%3AqdrantUrl%7D%22%2C%22QDRANT_API_KEY%22%3A%22%24%7Binput%3AqdrantApiKey%7D%22%2C%22COLLECTION_NAME%22%3A%22%24%7Binput%3AcollectionName%7D%22%7D%7D&inputs=%5B%7B%22type%22%3A%22promptString%22%2C%22id%22%3A%22qdrantUrl%22%2C%22description%22%3A%22Qdrant+URL%22%7D%2C%7B%22type%22%3A%22promptString%22%2C%22id%22%3A%22qdrantApiKey%22%2C%22description%22%3A%22Qdrant+API+Key%22%2C%22password%22%3Atrue%7D%2C%7B%22type%22%3A%22promptString%22%2C%22id%22%3A%22collectionName%22%2C%22description%22%3A%22Collection+Name%22%7D%5D) [![Install with Docker in VS Code Insiders](https://img.shields.io/badge/VS_Code_Insiders-Docker-24bfa5?style=flat-square&logo=visualstudiocode&logoColor=white)](https://insiders.vscode.dev/redirect/mcp/install?name=qdrant&config=%7B%22command%22%3A%22docker%22%2C%22args%22%3A%5B%22run%22%2C%22-p%22%2C%228000%3A8000%22%2C%22-i%22%2C%22--rm%22%2C%22-e%22%2C%22QDRANT_URL%22%2C%22-e%22%2C%22QDRANT_API_KEY%22%2C%22-e%22%2C%22COLLECTION_NAME%22%2C%22mcp-server-qdrant%22%5D%2C%22env%22%3A%7B%22QDRANT_URL%22%3A%22%24%7Binput%3AqdrantUrl%7D%22%2C%22QDRANT_API_KEY%22%3A%22%24%7Binput%3AqdrantApiKey%7D%22%2C%22COLLECTION_NAME%22%3A%22%24%7Binput%3AcollectionName%7D%22%7D%7D&inputs=%5B%7B%22type%22%3A%22promptString%22%2C%22id%22%3A%22qdrantUrl%22%2C%22description%22%3A%22Qdrant+URL%22%7D%2C%7B%22type%22%3A%22promptString%22%2C%22id%22%3A%22qdrantApiKey%22%2C%22description%22%3A%22Qdrant+API+Key%22%2C%22password%22%3Atrue%7D%2C%7B%22type%22%3A%22promptString%22%2C%22id%22%3A%22collectionName%22%2C%22description%22%3A%22Collection+Name%22%7D%5D&quality=insiders)

#### Manual Installation

Add the following JSON block to your User Settings (JSON) file in VS Code. You can do this by pressing `Ctrl + Shift + P` and typing `Preferences: Open User Settings (JSON)`.

```json
{
  "mcp": {
    "inputs": [
      {
        "type": "promptString",
        "id": "qdrantUrl",
        "description": "Qdrant URL"
      },
      {
        "type": "promptString",
        "id": "qdrantApiKey",
        "description": "Qdrant API Key",
        "password": true
      },
      {
        "type": "promptString",
        "id": "collectionName",
        "description": "Collection Name"
      }
    ],
    "servers": {
      "qdrant": {
        "command": "uvx",
        "args": ["mcp-server-qdrant"],
        "env": {
          "QDRANT_URL": "${input:qdrantUrl}",
          "QDRANT_API_KEY": "${input:qdrantApiKey}",
          "COLLECTION_NAME": "${input:collectionName}"
        }
      }
    }
  }
}
```

Or if you prefer using Docker, add this configuration instead:

```json
{
  "mcp": {
    "inputs": [
      {
        "type": "promptString",
        "id": "qdrantUrl",
        "description": "Qdrant URL"
      },
      {
        "type": "promptString",
        "id": "qdrantApiKey",
        "description": "Qdrant API Key",
        "password": true
      },
      {
        "type": "promptString",
        "id": "collectionName",
        "description": "Collection Name"
      }
    ],
    "servers": {
      "qdrant": {
        "command": "docker",
        "args": [
          "run",
          "-p", "8000:8000",
          "-i",
          "--rm",
          "-e", "QDRANT_URL",
          "-e", "QDRANT_API_KEY",
          "-e", "COLLECTION_NAME",
          "mcp-server-qdrant"
        ],
        "env": {
          "QDRANT_URL": "${input:qdrantUrl}",
          "QDRANT_API_KEY": "${input:qdrantApiKey}",
          "COLLECTION_NAME": "${input:collectionName}"
        }
      }
    }
  }
}
```

Alternatively, you can create a `.vscode/mcp.json` file in your workspace with the following content:

```json
{
  "inputs": [
    {
      "type": "promptString",
      "id": "qdrantUrl",
      "description": "Qdrant URL"
    },
    {
      "type": "promptString",
      "id": "qdrantApiKey",
      "description": "Qdrant API Key",
      "password": true
    },
    {
      "type": "promptString",
      "id": "collectionName",
      "description": "Collection Name"
    }
  ],
  "servers": {
    "qdrant": {
      "command": "uvx",
      "args": ["mcp-server-qdrant"],
      "env": {
        "QDRANT_URL": "${input:qdrantUrl}",
        "QDRANT_API_KEY": "${input:qdrantApiKey}",
        "COLLECTION_NAME": "${input:collectionName}"
      }
    }
  }
}
```

For workspace configuration with Docker, use this in `.vscode/mcp.json`:

```json
{
  "inputs": [
    {
      "type": "promptString",
      "id": "qdrantUrl",
      "description": "Qdrant URL"
    },
    {
      "type": "promptString",
      "id": "qdrantApiKey",
      "description": "Qdrant API Key",
      "password": true
    },
    {
      "type": "promptString",
      "id": "collectionName",
      "description": "Collection Name"
    }
  ],
  "servers": {
    "qdrant": {
      "command": "docker",
      "args": [
        "run",
        "-p", "8000:8000",
        "-i",
        "--rm",
        "-e", "QDRANT_URL",
        "-e", "QDRANT_API_KEY",
        "-e", "COLLECTION_NAME",
        "mcp-server-qdrant"
      ],
      "env": {
        "QDRANT_URL": "${input:qdrantUrl}",
        "QDRANT_API_KEY": "${input:qdrantApiKey}",
        "COLLECTION_NAME": "${input:collectionName}"
      }
    }
  }
}
```

## Contributing

If you have suggestions for how mcp-server-qdrant could be improved, or want to report a bug, open an issue!
We'd love all and any contributions.

### Development Setup

For rapid iteration during development:

```bash
# Install the project in editable mode
uv pip install -e .

# Test with MCP Inspector
npx @modelcontextprotocol/inspector uv run mcp-server-qdrant
```

### Publishing to PyPI

When extending or forking this project, ensure you have a unique package name:

1. **Update `pyproject.toml`** with a unique name (e.g., `mcp-server-qdrant-pro`):
   ```toml
   [project]
   name = "mcp-server-qdrant-pro"

   [project.scripts]
   mcp-server-qdrant-pro = "mcp_server_qdrant.main:main"

   [tool.hatch.build.targets.wheel]
   packages = ["src/mcp_server_qdrant"]
   ```

2. **Build the package** (requires PyPI account and API token):
   ```bash
   # Build without including source files
   uv build --no-sources
   ```

3. **Publish to PyPI**:
   ```bash
   # Note: API token must be scoped to "all projects" for first-time publishers
   uv publish --token pypi-yourtoken
   ```

### Testing `mcp-server-qdrant-pro` locally

The [MCP inspector](https://github.com/modelcontextprotocol/inspector) is the recommended tool for testing:

```bash
# Using development mode
npx @modelcontextprotocol/inspector uv run mcp-server-qdrant-pro

# For enterprise mode testing
ENTERPRISE_MODE=true COLLECTION_NAME="test" QDRANT_LOCAL_PATH="/tmp/test-storage" \
npx @modelcontextprotocol/inspector uv run mcp-server-qdrant-pro

# For enterprise testing with defined envs
npx @modelcontextprotocol/inspector \
  -e QDRANT_URL="https://edbe86b1-dd3c-4de3-940a-ee807504d165.us-west-2-0.aws.cloud.qdrant.io" \
  -e QDRANT_API_KEY="my_api_key" \
  -e COLLECTION_NAME="codebase_documents" \
  -e EMBEDDING_MODEL="jinaai/jina-embeddings-v2-base-code" \
  -- uvx mcp-server-qdrant-pro@latest
  
# For outlook testing with local qdrant docker instance
npx @modelcontextprotocol/inspector \
  -e ENTERPRISE_TOOL_SUITE=outlook \
  -e QDRANT_URL="http://artemis-nas:6333" \
  -e QDRANT_API_KEY="$QDRANT_API_KEY" \
  -e COLLECTION_NAME="email_collection" \
  -e EMBEDDING_PROVIDER="voyageai" \
  -e EMBEDDING_MODEL="voyage-3-large" \
  -e VOYAGE_API_KEY="$VOYAGE_API_KEY" \
  -- uv run mcp-server-qdrant-pro
```

## License

This MCP server is licensed under the Apache License 2.0. This means you are free to use, modify, and distribute the
software, subject to the terms and conditions of the Apache License 2.0. For more details, please see the LICENSE file
in the project repository.
