Back to MCP directory
publicPublicdnsLocal runtime

mcp-typesense-server

一种MCP服务器实现,它使AI模型能够通过查询文档、检索特定项目和访问集合统计信息的工具,来发现、搜索和分析存储在Typesense集合中的数据。

article

README

MseeP.ai Security Assessment Badge

Typesense MCP Server


npm version License: MIT Node.js Version

A Model Context Protocol (MCP) server implementation that provides AI models with access to Typesense search capabilities. This server enables LLMs to discover, search, and analyze data stored in Typesense collections.

Demo

Typesense MCP Server Demo | Claude Desktop

Features

Resources

  • List and access collections via typesense:// URIs
  • Each collection has a name, description, and document count
  • JSON mime type for schema access

Tools

  • typesense_query

    • Search for documents in Typesense collections with powerful filtering
    • Input: Query text, collection name, search fields, filters, sort options, limit
    • Returns matching documents with relevance scores
  • typesense_get_document

    • Retrieve specific documents by ID from collections
    • Input: Collection name, document ID
    • Returns complete document data
  • typesense_collection_stats

    • Get statistics about a Typesense collection
    • Input: Collection name
    • Returns collection metadata, document count, and schema information

Prompts

  • analyze_collection

    • Analyze collection structure and contents
    • Input: Collection name
    • Output: Insights about schema, data types, and statistics
  • search_suggestions

    • Get suggestions for effective search queries for a collection
    • Input: Collection name
    • Output: Recommended search strategies based on collection schema

Installation

Via npm

# Global installation
npm install -g typesense-mcp-server

# Local installation
npm install typesense-mcp-server

Via mcp-get

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

Development

Install dependencies:

npm install

Build the server:

npm run build

For development with auto-rebuild:

npm run watch

Installation for Development

Using Claude Desktop

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

{
  "mcpServers": {
    "typesense": {
      "command": "node",
      "args": [
        "~/typesense-mcp-server/dist/index.js",
        "--host", "your-typesense-host",
        "--port", "8108",
        "--protocol", "http",
        "--api-key", "your-api-key"
      ]
    },
  }
}

Debugging

Since MCP servers communicate over stdio, debugging can be challenging. We recommend using the MCP Inspector, which is available as a package script:

npm run inspector

The Inspector will provide a URL to access debugging tools in your browser.

Components

Resources

The server provides information about Typesense collections:

  • Collection Schemas (typesense://collections/<collection>)
    • JSON schema information for each collection
    • Includes field names and data types
    • Sample documents for understanding data structure

Resource Templates

The server provides templates for:

  • typesense_search - Template for constructing Typesense search queries
  • typesense_collection - Template for viewing Typesense collection details

Usage with Claude Desktop

To use this server with the Claude Desktop app, add the following configuration to the "mcpServers" section of your claude_desktop_config.json:

{
  "mcpServers": {
    "typesense": {
      "command": "npx",
      "args": [
        "-y",
        "typesense-mcp-server",
        "--host", "your-typesense-host",
        "--port", "8108",
        "--protocol", "http",
        "--api-key", "your-api-key"
      ]
    }
  }
}

Logging

The server logs information to a file located at:

/tmp/typesense-mcp.log

This log contains detailed information about server operations, requests, and any errors that occur.

License

This MCP server is licensed under the MIT License. This means you are free to use, modify, and distribute the software, subject to the terms and conditions of the MIT License. For more details, please see the LICENSE file in the project repository.

help

Runtime guide

cloud

Hosted runtime

Hosted servers run from a provider-managed environment. You usually connect the MCP client to the hosted endpoint or follow the provider's authorization flow, without keeping a local process alive

  1. Open provider connection page
  2. Authorize or copy endpoint
  3. Connect from your MCP client
terminal

Local runtime / other methods

Local servers run on your own machine or infrastructure. You normally copy the server_config into your MCP client, install the required package, and provide env variables from env_schema when needed

  1. Copy server_config
  2. Install required package
  3. Fill env variables and restart client