Qdrant

🚀 MCP Server: mcp-server-qdrant Usage Guide

This guide provides a comprehensive introduction to the installation, configuration, startup, and usage of the MCP Server (mcp-server-qdrant). It also includes information on contributing to the project and testing the server.

📦 Installation

Install Node.js and npm

1. Visit the Node.js official website to download and install the Node.js version suitable for your operating system.
2. Ensure that npm (Node Package Manager), which is part of Node.js, is installed.

Install MCP CLI

Run the following command in the terminal or command prompt to globally install MCP CLI:

npm install mcp-cli -g

⚙️ Configuration

Create a Workspace

1. Open the terminal and navigate to your chosen working directory.

2. Initialize a new Git repository (optional but recommended):

   git init
   

3. Create a package.json file and add the following content:

   {
     "name": "mcp-server-qdrant",
     "version": "1.0.0",
     "scripts": {
       "start": "mcp start mcp_server_qdrant/server.py"
     },
     "dependencies": {
       "mcp-cli": "^2.3.0"
     }
   }
   

4. Install project dependencies:

   npm install
   

Set Up Project Files

1. .env File

Create an .env file and add the following content:

QDRANT_URL=http://localhost:6333
COLLECTION_NAME=mcp_demo

2. mcp_server_qdrant/server.py

Create a new Python file server.py and add the following content:

import os
from mcp_server import server

if __name__ == "__main__":
    server.start(
        qdrant_url=os.getenv("QDRANT_URL"),
        collection_name=os.getenv("COLLECTION_NAME")
    )

🚀 Start the Service

Start with npm Script

Run the following command in the terminal:

npm start

This will start the MCP server, which will use the QDrant URL and collection name you specified in server.py.

Run the Python Script Directly

If you don't want to use the npm script, you can run it directly:

python mcp_server_qdrant/server.py

🛠️ Configure MCP CLI

MCP CLI is a command-line tool for interacting with the MCP server. You can configure your project in the following ways:

Global Configuration

Edit the global mcp.json file (located at $HOME/.config/mcp/cli/) and add the following content:

{
  "global": {
    "servers": {
      "qdrant": {
        "command": "npm",
        "args": ["start"],
        "env": {}
      }
    }
  }
}

Workspace Configuration

Create an mcp.json file in the project root directory and add the following content:

{
  "servers": {
    "qdrant": {
      "command": "npm",
      "args": ["start"],
      "env": {}
    }
  }
}

💻 Usage

Create a New Project

Run the following command in the terminal to create a new project:

mcp new my_project
cd my_project

Start the Server

Use the following command to start the MCP server:

mcp start

This will start the server you defined in server.py.

🤝 Contribution

Welcome to contribute code to this project! You can participate in the following ways:

1. Submit issues: Report the issues you encounter on GitHub.
2. Submit feature requests: Also submit new feature requests in the GitHub repository.
3. Pull requests: Fix bugs or add new features to the project.

🧪 Testing

Check with MCP

Use the MCP CLI tool to check your server:

mcp inspect

This will display the status of your configured server and other relevant information.

Manual Testing

Run the following command in the terminal to manually start the service and conduct testing:

npm start

Then, you can view the status of your connected QDrant service by visiting http://localhost:6333.