The Searchcraft MCP Server provides a suite of tools for managing your Searchcraft cluster's Documents, Indexes, Federations, Access Keys, and Analytics. It enables MCP Clients, like Claude Desktop, to be prompted in plain English to perform administrative actions like setting up search indexes, access keys, ingesting documents, viewing analytics, searching indexes, and more.
Available Tools
The Searchcraft MCP Server provides two main categories of tools:
Engine API Tools
These tools provide direct access to your Searchcraft cluster's core functionality for managing indexes, documents, federations, authentication, and search operations.
Index Management
Tool Name | Description |
---|---|
create_index | Create a new index with the specified schema. This will empty the index if it already exists. |
delete_index | Delete an index and all its documents permanently. |
get_all_index_stats | Get document counts and statistics for all indexes. |
get_index_schema | Get the schema definition for a specific index. |
get_index_stats | Get statistics and metadata for a specific index (document count, etc.). |
list_all_indexes | Get a list of all indexes in the Searchcraft instance. |
patch_index | Make partial configuration changes to an index schema (search_fields, weight_multipliers, etc.). |
update_index | Replace the entire contents of an existing index with a new schema definition. |
Document Management
Tool Name | Description |
---|---|
add_documents | Add one or multiple documents to an index. Documents should be provided as an array of JSON objects. |
delete_all_documents | Delete all documents from an index. The index will continue to exist after all documents are deleted. |
delete_document_by_id | Delete a single document from an index by its internal Searchcraft ID (_id). |
delete_documents_by_field | Delete one or several documents from an index by field term match (e.g., {id: 'xyz'} or {title: 'foo'}). |
delete_documents_by_query | Delete one or several documents from an index by query match. |
get_document_by_id | Get a single document from an index by its internal Searchcraft ID (_id). |
Federation Management
Tool Name | Description |
---|---|
create_federation | Create or update a federation with the specified configuration. |
delete_federation | Delete a federation permanently. |
get_federation_details | Get detailed information for a specific federation. |
get_federation_stats | Get document counts per index for a federation as well as the total document count. |
get_organization_federations | Get a list of all federations for a specific organization. |
list_all_federations | Get a list of all federations in the Searchcraft instance. |
update_federation | Replace the current federation entity with an updated one. |
Authentication & Key Management
Tool Name | Description |
---|---|
create_key | Create a new authentication key with specified permissions and access controls. |
delete_all_keys | Delete all authentication keys on the Searchcraft cluster. Use with extreme caution! |
delete_key | Delete a specific authentication key permanently. |
get_application_keys | Get a list of all authentication keys associated with a specific application. |
get_federation_keys | Get a list of all authentication keys associated with a specific federation. |
get_key_details | Get detailed information for a specific authentication key. |
get_organization_keys | Get a list of all authentication keys associated with a specific organization. |
list_all_keys | Get a list of all authentication keys on the Searchcraft cluster. |
update_key | Update an existing authentication key with new configuration. |
Stopwords Management
Tool Name | Description |
---|---|
add_stopwords | Add custom stopwords to an index. These are added on top of the default language-specific dictionary. |
delete_all_stopwords | Delete all custom stopwords from an index. This only affects custom stopwords, not the default language dictionary. |
delete_stopwords | Delete specific custom stopwords from an index. This only affects custom stopwords, not the default language dictionary. |
get_index_stopwords | Get all stopwords for an index, including both default language dictionary and custom stopwords. |
Synonyms Management
Tool Name | Description |
---|---|
add_synonyms | Add synonyms to an index. Synonyms only work with fuzzy queries, not exact match queries. |
delete_all_synonyms | Delete all synonyms from an index. |
delete_synonyms | Delete specific synonyms from an index by their keys. |
get_index_synonyms | Get all synonyms defined for an index. |
Search & Analytics
Tool Name | Description |
---|---|
get_measure_conversion | Get measurement conversion data with optional filtering and aggregation parameters. *requires Clickhouse if running locally |
get_measure_summary | Get measurement summary data with optional filtering and aggregation parameters. *requires Clickhouse if running locally |
get_search_results | Performs a search query using the Searchcraft API with support for fuzzy/exact matching, facets, and date ranges. |
get_prelim_search_data | Get schema fields and facet information for a search index to understand available fields for constructing queries. |
get_searchcraft_status | Get the current status of the Searchcraft search service. |
Import Tools
These tools provide workflows for importing JSON data and automatically generating Searchcraft schemas. Perfect for quickly setting up new indexes from existing data sources.
Tool Name | Description |
---|---|
analyze_json_from_file | Read JSON data from a local file and analyze its structure to understand field types and patterns for Searchcraft index schema generation. |
analyze_json_from_url | Fetch JSON data from a URL and analyze its structure to understand field types and patterns for Searchcraft index schema generation. |
generate_searchcraft_schema | Generate a complete Searchcraft index schema from analyzed JSON structure, with customizable options for search fields, weights, and other index settings. |
create_index_from_json | Complete workflow to create a Searchcraft index from JSON data. Fetches JSON from URL or file, analyzes structure, generates schema, and creates the index in one step. |
Import Tools Workflow
The import tools are designed to work together in a streamlined workflow:
- Analyze → Use
analyze_json_from_file
oranalyze_json_from_url
to examine your JSON data structure - Generate → Use
generate_searchcraft_schema
to create a customized Searchcraft schema from the analysis - Create → Use the Engine API
create_index
tool to create the index with your generated schema - Import → Use
add_documents
to populate your new index with data
Or use the all-in-one approach:
- One-Step → Use
create_index_from_json
to analyze, generate schema, and create the index all in one command
Getting Started
Environment Variables
Create .env
file at the project's root and fill in the values:
Installation & Setup
Make sure your environment has the correct version of node selected.
Install dependencies with yarn
Build the server
This creates two server versions:
dist/server.js
- HTTP server for testing and remote deploymentdist/stdio-server.js
- stdio server for Claude Desktop
Usage
Option 1: Claude Desktop (stdio) - Recommended
For local use with Claude Desktop, use the stdio version which provides better performance and reliability.
claude_desktop_config.json
The claude desktop config file can be found at:
- macOS:
~/Library/Application Support/Claude/claude_desktop_config.json
- Windows:
%APPDATA%\Claude\claude_desktop_config.json
If the file doesn't exist, create it.
Option 2: Claude Code
For use with Claude Code, use the CLI to configure the MCP server:
Basic setup:
With environment variables:
Configuration scopes:
--scope local
(default): Available only to you in the current project--scope project
: Shared with team via.mcp.json
file (recommended for teams)--scope user
: Available to you across all projects
Managing servers:
Option 3: Open WebUI (via Pipelines)
Open WebUI supports MCP servers through its Pipelines framework. This requires creating a custom pipeline that bridges your MCP server to Open WebUI.
Step 1: Start the Searchcraft MCP HTTP server
Step 2: Create an MCP Pipeline for Open WebUI
Create a file called searchcraft_mcp_pipeline.py
:
Step 3: Install the Pipeline in Open WebUI
- Via Admin Panel:
- Go to Admin Settings → Pipelines
- Click "Add Pipeline"
- Paste the pipeline code above
- Configure the valves with your Searchcraft settings:
MCP_SERVER_URL
:http://localhost:3100/mcp
ENDPOINT_URL
: Your Searchcraft cluster URLADMIN_KEY
: Your Searchcraft admin key
- Via Docker Environment:
Step 4: Configure Open WebUI to use Pipelines
- Start Open WebUI with Pipelines support:
- In Open WebUI Settings → Connections:
- Set OpenAI API URL to your Pipelines instance
- Enable the Searchcraft MCP Pipeline
Option 4: HTTP Server (for testing/remote deployment)
Start the HTTP server for testing, debugging, or remote deployment:
For Claude Desktop with HTTP server, you'll need mcp-remote:
claude_desktop_config.json
Available Scripts
stdio vs HTTP: Which to Choose?
Feature | stdio (Recommended) | HTTP |
---|---|---|
Performance | ✅ Direct IPC, lower latency | ⚠️ HTTP overhead |
Security | ✅ No exposed ports | ⚠️ Network port required |
Simplicity | ✅ No port management | ⚠️ Port conflicts possible |
Claude Desktop | ✅ Native support | ⚠️ Requires mcp-remote |
Claude Code | ✅ Native support | ✅ Native support |
Open WebUI | ❌ Not supported | ✅ Via Pipelines framework |
Remote Access | ❌ Local only | ✅ Can deploy remotely |
Testing | ⚠️ Requires MCP tools | ✅ Easy with curl/Postman |
Multiple Clients | ❌ One client at a time | ✅ Multiple concurrent clients |
Use stdio when:
- Using Claude Desktop or Claude Code locally
- You want the best performance
- You prefer simplicity
Use HTTP when:
- You need remote access
- You want easy testing/debugging
- You need multiple concurrent clients
- You're deploying to a server
- Using Open WebUI or other web-based interfaces
Debugging
Claude Desktop Logs
To view Claude Desktop's logs for debugging MCP connections:
Testing with MCP Inspector
The MCP Inspector allows you to test your server tools interactively.
For stdio server (recommended):
- Choose Transport Type: stdio
- Command:
node dist/stdio-server.js
For HTTP server:
- Choose Transport Type: Streamable HTTP
- URL:
http://localhost:3100/mcp
Manual Testing
Test HTTP server:
Test stdio server:
Resources
- 📘 Searchcraft Docs
- 🛰️ Vektron Dashboard
- 💬 Searchcraft Discord
- 🧠 Searchcraft Reddit
- 🧪 Searchcraft SDK on npm
Issues and Feature Requests
Visit https://github.com/searchcraft-inc/searchcraft-issues
License
Licensed under the Apache 2.0 License.
This server cannot be installed
hybrid server
The server is able to function both locally and remotely, depending on the configuration or use case.
An MCP server that enables AI assistants like Claude Desktop to search and retrieve information from custom search indexes created with Searchcraft.
Related MCP Servers
- AsecurityAlicenseAqualityThe Search MCP Server enables seamless integration of network and local search capabilities in tools like Claude Desktop and Cursor, utilizing the Brave Search API for high-concurrency and asynchronous requests.Last updated -172MIT License
- -securityFlicense-qualityAn MCP server that allows AI assistants like Claude to execute terminal commands on the user's computer and return the output, functioning like a terminal through AI.Last updated -57
- -securityFlicense-qualityAn MCP server that integrates with Claude to provide smart documentation search capabilities across multiple AI/ML libraries, allowing users to retrieve and process technical information through natural language queries.Last updated -
- -securityAlicense-qualityAn MCP server that integrates with Sonar API to provide Claude with real-time web search capabilities for comprehensive research.Last updated -0MIT License