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 桌面

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

在 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 服务器通过 stdio 进行通信，调试可能具有挑战性。我们推荐使用 MCP 检查器，它作为包脚本提供：

npm run inspector

检查器将提供一个 URL，用于在浏览器中访问调试工具。

组件

资源

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

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

资源模板

服务器提供以下模板：

• typesense_search - 用于构建 Typesense 搜索查询的模板
• typesense_collection - 用于查看 Typesense 集合详细信息的模板

与 Claude 桌面一起使用

要将此服务器与 Claude 桌面应用程序一起使用，请将以下配置添加到 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 文件。