README.md•2.59 kB
# Typesense MCP Server
[](https://smithery.ai/server/@avarant/typesense-mcp-server)
A [Model Context Protocol](https://github.com/modelcontextprotocol/python-sdk) (MCP) Server that interfaces with [Typesense](https://typesense.org/)
## Installation
### Installing via Smithery
To install Typesense Server Integration for Claude Desktop automatically via [Smithery](https://smithery.ai/server/@avarant/typesense-mcp-server):
```bash
npx -y @smithery/cli install @avarant/typesense-mcp-server --client claude
```
### Manual Installation
Install [uv](https://docs.astral.sh/uv/getting-started/installation/)
On Mac you can install it using [homebrew](https://brew.sh/)
```shell
brew install uv
```
Clone the package
```shell
git clone git@github.com:avarant/typesense-mcp-server.git ~/typesense-mcp-server
```
Update your `.cursor/mcp.json` to use in **Cursor**
```json
{
"mcpServers": {
"typesense": {
"command": "uv",
"args": ["--directory", "~/typesense-mcp-server", "run", "mcp", "run", "main.py"],
"env": {
"TYPESENSE_HOST": "",
"TYPESENSE_PORT": "",
"TYPESENSE_PROTOCOL": "",
"TYPESENSE_API_KEY": ""
}
}
}
}
```
## Available Tools
The Typesense MCP Server provides the following tools:
### Server Management
- `check_typesense_health` - Checks the health status of the configured Typesense server
- `list_collections` - Retrieves a list of all collections in the Typesense server
### Collection Management
- `describe_collection` - Retrieves the schema and metadata for a specific collection
- `export_collection` - Exports all documents from a specific collection
- `create_collection` - Creates a new collection with the provided schema
- `delete_collection` - Deletes a specific collection
- `truncate_collection` - Truncates a collection by deleting all documents but keeping the schema
### Document Operations
- `create_document` - Creates a single new document in a specific collection
- `upsert_document` - Upserts (creates or updates) a single document in a specific collection
- `index_multiple_documents` - Indexes (creates, upserts, or updates) multiple documents in a batch
- `delete_document` - Deletes a single document by its ID from a specific collection
- `import_documents_from_csv` - Imports documents from CSV data into a collection
### Search Capabilities
- `search` - Performs a keyword search on a specific collection
- `vector_search` - Performs a vector similarity search on a specific collection