README - searchcraft-mcp-server by searchcraft-inc

searchcraft-mcp-server

An MCP Server powered by Searchcraft – the developer-first vertical search engine.

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

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 & Measurement

Tool Name	Description
get_measure_conversion	Get measurement conversion data with optional filtering and aggregation parameters.
get_measure_summary	Get measurement summary data with optional filtering and aggregation parameters.
get_search_results	Performs a search query using the Searchcraft API with support for fuzzy/exact matching, facets, and date ranges.
get_searchcraft_status	Get the current status of the Searchcraft search service.

Getting Started

Environment Variables

Create .env file at the project's root and fill in the values:

# Server Config
USER_AGENT=searchcraft-mcp-server/<project-version>
DEBUG=true
PORT=3100

# Searchcraft Config
ENDPOINT_URL= # The endpoint url of your Searchcraft Cluster
ADMIN_KEY= # The admin key (super user key) of your Searchcraft Cluster

Running the Server

Make sure your environment has the correct version of node selected.

nvm use

Install dependencies with yarn

yarn

Build & Start the server

yarn build
yarn start

Usage With Claude Desktop

The server must be running in order for Claude Desktop to detect searchcraft-mcp-server's tools.

searchcraft-mcp-server uses StreamableHTTPServerTransport, so in order to connect it to Claude Desktop, we use mcp-remote ↗︎.

In your claude desktop config file, add the following:

claude_desktop_config.json

{
  "mcpServers": {
    "searchcraft": {
      "command": "npx",
      "args": [
        "mcp-remote",
        "http://localhost:<MY-PORT-FROM-ENV>/mcp"
      ]
    }
  }
}

The claude desktop config file can be found at /Users/[My Workspace]]/Library/Application Support/Claude/claude_desktop_config.json. If no file exists here you can create it.

Claude Desktop Node Version

We have experienced that when Claude Desktop runs the command to connect to the MCP server, it can sometimes choose an older version of Node. If older versions of node are installed on your system, this can lead to issues. Ensure that your default Node version on your system is high enough to properly run the server.

Debugging

To view claude's logs for debugging purposes, use the npm script:

yarn claude-logs

Inspector Tool

You can view and try out the available tools/prompts/resources using the inspector. While the mcp server is running, you can launch the inspector:

yarn inspect

Choose Transport Type: Streamable HTTP
Specify the URL that the server is running on, including the port number.
Hit "Connect"

http://localhost:<MY-PORT-FROM-ENV>/mcp

The Inspector allows you to view available tools and to try making test calls to them.

Resources

License

Licensed under the .

Built with 🛰️ by the Searchcraft team