Typesense MCP 服务器

---

这是一个实现了模型上下文协议（MCP）的服务器，它为AI模型提供了访问Typesense搜索功能的能力。此服务器使LLMs能够发现、搜索并分析存储在Typesense集合中的数据。

演示

功能

资源

• 通过 typesense:// URI 列出和访问集合
• 每个集合都有名称、描述和文档数量
• 使用JSON MIME类型访问模式

工具

• typesense_query

  • 在Typesense集合中搜索文档，具有强大的过滤功能
  • 输入：查询文本、集合名称、搜索字段、过滤器、排序选项、限制
  • 返回匹配的文档及其相关性评分

• typesense_get_document

  • 根据ID从集合中检索特定文档
  • 输入：集合名称、文档ID
  • 返回完整的文档数据

• typesense_collection_stats

  • 获取关于Typesense集合的统计信息
  • 输入：集合名称
  • 返回集合元数据、文档数量和模式信息

提示

• analyze_collection

  • 分析集合结构和内容
  • 输入：集合名称
  • 输出：关于模式、数据类型和统计信息的见解

• search_suggestions

  • 获取针对集合的有效搜索查询建议
  • 输入：集合名称
  • 输出：基于集合模式推荐的搜索策略

安装

通过npm

# 全局安装
npm install -g typesense-mcp-server

# 局部安装
npm install typesense-mcp-server

通过mcp-get

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

开发

安装依赖项：

npm install

构建服务器：

npm run build

开发时自动重建：

npm run watch

开发安装

使用Claude Desktop

要与Claude Desktop一起使用，请添加服务器配置：

在MacOS上：~/Library/Application Support/Claude/claude_desktop_config.json

在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"
      ]
    },
  }
}

调试

由于MCP服务器通过标准I/O进行通信，调试可能会很困难。我们推荐使用MCP Inspector，它作为一个包脚本提供：

npm run inspector

Inspector会提供一个URL，以便您可以在浏览器中访问调试工具。

组件

资源

服务器提供有关Typesense集合的信息：

• 集合模式 (typesense://collections/<collection>)
  • 每个集合的JSON模式信息
  • 包括字段名称和数据类型
  • 示例文档以了解数据结构

工具

服务器提供以下工具用于与Typesense交互：

• typesense_list_collections - 列出所有可用的集合及其模式

  • 支持零配置发现和路由
  • LLM可以在运行时枚举集合，并在搜索前选择正确的集合
  • 当集合因环境、租户或版本而异时非常有用
  • 返回模式推断的字段定义（可搜索、可分类、数值字段）
  • 支持 include_fields 参数以控制详细程度

• typesense_query - 在集合中搜索文档

  • 带有可定制参数的全文搜索
  • 支持过滤、排序和分页

• typesense_get_document - 根据ID检索特定文档

• typesense_collection_stats - 获取特定集合的详细统计信息

资源模板

服务器提供以下模板：

• typesense_search - 构建Typesense搜索查询的模板
• typesense_collection - 查看Typesense集合详情的模板

使用Claude Desktop

要使用此服务器与Claude Desktop应用程序一起使用，请在您的 claude_desktop_config.json 的“mcpServers”部分添加以下配置：

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

日志

服务器将信息记录到位于以下位置的文件中：

/tmp/typesense-mcp.log

此日志包含有关服务器操作、请求以及发生的任何错误的详细信息。

许可证

此MCP服务器根据MIT许可证发布。这意味着您可以自由地使用、修改和分发该软件，但需遵守MIT许可证的条款和条件。如需更多详情，请参阅项目仓库中的LICENSE文件。