MCP Typesense Server

🚀 Typesense MCP Server

A server implementation based on the Model Context Protocol (MCP) that enables AI models to access the search capabilities of Typesense. This server allows large language models to discover, search, and analyze data stored in Typesense collections.

🚀 Quick Start

A Typesense MCP Server is a server implementation based on Model Context Protocol (MCP), which provides AI models with the ability to access the search capabilities of Typesense. This server enables large language models to discover, search, and analyze data stored in Typesense collections.

💻 Usage Examples

[基础用法/Basic Usage]

✨ Features

Resources

• List and access collections via typesense:// URIs.
• Each collection has a name, description, and number of documents.
• JSON MIME type is used for schema access.

Tools

• typesense_query

  • Search for documents in Typesense collections with powerful filtering capabilities.
  • Input: query text, collection name, search fields, filtering conditions, sorting options, limit.
  • Return matching documents and their relevance scores.

• typesense_get_document

  • Retrieve a specific document by ID from a collection.
  • Input: collection name, document ID.
  • Return the full document data.

• typesense_collection_stats

  • Get statistics for a Typesense collection.
  • Input: collection name.
  • Return collection metadata, number of documents, and schema information.

Prompts

• analyze_collection

  • Analyze the structure and content of a collection.
  • Input: collection name.
  • Output: Insights on schema, data types, and statistics.

• search_suggestions

  • Search suggestions.
  • Input: search term.
  • Output: Context-based search suggestions.

📦 Installation

Global Installation via npm

npm install -g typesense-mcp-server

Local Installation

npm install typesense-mcp-server

Using the mcp-get Command

npx @michaellatman/mcp-get@latest install typesense-mcp-server

📚 Documentation

Install Dependencies

npm install

Build the Server

npm run build

Use Debugging Tools

• MCP Inspector: An interactive tool for analyzing and monitoring MCP services.

npm run inspect

Configuration for Claude Desktop

Add the following to your configuration file:

{
  "typesense-mcp-server": {
    "path": "~/.config/typesense-mcp-server",
    "log_level": "info"
  }
}

Logging

The log files for this MCP server are located at ~/.config/typesense-mcp-server/logs. The log files record all operations, errors, and other important events to help you monitor and maintain the server status.

📄 License

This MCP server is released under the MIT License. This means you can freely use, modify, and distribute the software, but you must comply with the terms and conditions of the MIT License. For more details, please refer to the LICENSE file in the project repository.