ex. ## Installation To use with Claude Desktop, add the server config: On MacOS: `~/Library/Application Support/Claude/claude_desktop_config.json` On Windows: `%APPDATA%/Claude/claude_desktop_config.json` ``` npm i -g @kazuph/mcp-qdrant-docs ``` ### Using `npx` The recommended way to run this server is using `npx` within your MCP client configuration (e.g., Claude Desktop's `claude_desktop_config.json`). This avoids the need for global installation. **Example `claude_desktop_config.json` using `npx`:** ```json { "mcpServers": { "react-router-docs": { // A unique name for this server instance "command": "npx", "args": [ "@kazuph/mcp-qdrant-docs", // The command registered in package.json bin // Optional: Add command-line arguments here if needed // "--start-url", "https://some-default-url.com/", // "--debug" ], // Optional: Set environment variables for configuration "env": { "DOCS_URL": "https://reactrouter.com/", "QDRANT_URL": "http://your-qdrant-instance:6333", "COLLECTION_NAME": "react-router-docs", // Base name for the collection "EMBEDDING_MODEL": "sentence-transformers/all-MiniLM-L6-v2" // "DEBUG": "true" // Alternative way to enable debug logging } } // You can add more server instances for different documentation sites here } } ``` ## Command-Line Options When running the server directly (e.g., using `npx mcp-qdrant-docs` or `npm run dev --`), you can use the following command-line options. These options override corresponding environment variables if both are set. - `--start-url ` or `-s `: - **Required (if `DOCS_URL` env var is not set).** - The starting URL of the website to scrape. - Overrides the `DOCS_URL` environment variable. - `--limit ` or `-l `: - Maximum number of pages to scrape. - Default: `300`. - `--match ` or `-m `: - URL path patterns (prefix match) to limit scraping. Can be specified multiple times. - Example: `--match /docs/ --match /api/` - Default: Scrapes all pages under the `start-url` domain. - `--force-reindex`: - Force re-scraping and re-indexing even if the Qdrant collection already exists. - Default: `false`. - `--collection-name ` or `-c `: - Base name for the Qdrant collection. The final collection name will be `-`. - Overrides the `COLLECTION_NAME` environment variable. - Default: `docs-collection`. - `--qdrant-url `: - URL of the Qdrant instance. - Overrides the `QDRANT_URL` environment variable. - Default: `http://localhost:6333`. - `--embedding-model `: - Name of the sentence transformer model to use for embeddings (from Hugging Face or local). - Overrides the `EMBEDDING_MODEL` environment variable. - Default: `Xenova/all-MiniLM-L6-v2`. - `--debug`: - Enable detailed debug logging. - Overrides the `DEBUG` environment variable (if set to `true`). - Default: `false`. - `--help` or `-h`: - Show the help message listing all options. **Example using command-line options:** ```bash npx @kazuph/mcp-qdrant-docs --start-url https://example-docs.com/ --collection-name my-docs --limit 50 --debug ``` **Configuration Priority:** The server uses the following priority for settings: 1. **Command-line arguments:** (e.g., `--start-url`, `--collection-name`) - Highest priority. 2. **Environment variables:** (e.g., `DOCS_URL`, `COLLECTION_NAME`) - Used if command-line arguments are not provided. 3. **Default values:** (Defined within the code) - Lowest priority. ## Example: Adding React Router Documentation To add a server instance specifically for querying React Router documentation, add the following entry to your `mcpServers` configuration (e.g., in `claude_desktop_config.json`): ```json { "mcpServers": { // ... other servers ... "react-router-docs": { "command": "npx", // Or the

mcp-qdrant-docs MCP Server

Comments