MCP Typesense Server

🚀 Typesense MCP 服务器

一个基于 Model Context Protocol (MCP) 的服务器实现，为 AI 模型提供访问 Typesense 搜索功能的能力。此服务器可助力大型语言模型发现、搜索和分析存储在 Typesense 集合中的数据。

🚀 快速开始

本服务器基于 Model Context Protocol (MCP) 实现，能让 AI 模型访问 Typesense 的搜索功能，大型语言模型可借此对 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

使用调试工具

• MCP Inspector：用于分析和监控 MCP 服务的交互式工具

  npm run inspect
  

配置指南

适用于 Claude Desktop

将以下内容添加到你的配置文件中：

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

日志记录

此 MCP 服务器的日志文件位于 ~/.config/typesense-mcp-server/logs。日志文件会记录所有操作、错误和其他重要事件，帮助您监控和维护服务器状态。

📄 许可证

本 MCP 服务器根据 MIT 许可证发布。这意味着您可以自由使用、修改和分发软件，但需遵守 MIT 许可证的条款和条件。有关详细信息，请参阅项目仓库中的 LICENSE 文件。