使用说明

项目简介

Typesense MCP Server 是一个 MCP 服务器实现，它充当 LLM 客户端和 Typesense 搜索引擎之间的桥梁。通过此服务器，LLM 应用可以安全、便捷地利用 Typesense 的强大搜索和数据管理功能，实现上下文感知和功能扩展。

主要功能点

服务器管理工具: 提供检查 Typesense 服务器健康状态和列出所有集合的功能。
集合管理工具: 支持对 Typesense 集合进行描述、导出、创建、删除和清空等操作。
文档操作工具: 允许在 Typesense 集合中创建、更新、批量索引、删除和从 CSV 导入文档。
搜索能力工具: 提供关键词搜索和向量相似度搜索功能，充分利用 Typesense 的搜索能力。

安装步骤

安装 uv: 按照仓库 README.md 中的指引，安装 'uv' 包管理器。对于 macOS 用户，推荐使用 Homebrew 安装：
```
brew install uv
```

克隆仓库: 使用 Git 克隆 'typesense-mcp-server' 仓库到本地：

git clone [email protected]:avarant/typesense-mcp-server.git ~/typesense-mcp-server

请注意将 '~/typesense-mcp-server' 替换为您希望存放仓库的实际路径。

服务器配置

为了让 MCP 客户端（如 Cursor）连接到 Typesense MCP Server，您需要在客户端的 MCP 配置文件（通常是 '.cursor/mcp.json'）中添加服务器配置信息。以下是根据仓库提供的示例生成的配置，您需要根据实际的 Typesense 服务器信息进行修改：

{
  "mcpServers": {
    "typesense-server": {  // 服务器名称，可以自定义
      "command": "uv",     // 启动命令，这里使用 uv 包管理器
      "args": [            // 启动参数
        "--directory", 
        "~/typesense-mcp-server", //  Typesense MCP Server 仓库的本地路径，请替换为实际路径
        "run", 
        "mcp", 
        "run", 
        "main.py"
      ],
      "env": {             // 环境变量配置，用于连接 Typesense 服务器
        "TYPESENSE_HOST": "your_typesense_host",      //  Typesense 服务器主机地址，例如：localhost
        "TYPESENSE_PORT": "8108",                     //  Typesense 服务器端口，默认为 8108
        "TYPESENSE_PROTOCOL": "http",                 //  Typesense 服务器协议，http 或 https
        "TYPESENSE_API_KEY": "your_typesense_api_key" //  Typesense API 密钥，**必填**
      }
    }
  }
}

配置参数说明:

'server-name': 为您的 MCP 服务器自定义一个名称，例如 'typesense-server'。
'command': 指定用于启动服务器的命令，这里使用 'uv'。
'args': 传递给启动命令的参数列表。
- '--directory': 指定服务器代码所在的目录，请替换 '~/typesense-mcp-server' 为您克隆仓库的实际路径。
- 'run mcp run main.py': 使用 'uv' 运行 'main.py' 文件，启动 MCP 服务器。
'env': 环境变量配置，用于配置 Typesense 客户端连接到您的 Typesense 服务器。
- 'TYPESENSE_HOST': 您的 Typesense 服务器的主机名或 IP 地址。
- 'TYPESENSE_PORT': 您的 Typesense 服务器的端口号。
- 'TYPESENSE_PROTOCOL': 您的 Typesense 服务器使用的协议，通常是 'http' 或 'https'。
- 'TYPESENSE_API_KEY': 您的 Typesense API 密钥，请务必替换为正确的密钥。

请根据您的 Typesense 服务器实际配置信息，修改 'env' 部分的参数值。 您需要将 'your_typesense_host' 和 'your_typesense_api_key' 替换为真实的信息。

基本使用方法

配置完成后，MCP 客户端（如 Cursor）将能够连接到 Typesense MCP Server 并调用其提供的工具。具体工具的使用方法和参数，请参考 'main.py' 文件中每个工具函数的文档注释 (docstring)。客户端会通过 JSON-RPC 协议与服务器通信，调用相应的工具并获取结果。

例如，在 Cursor 中，您可以使用 '@工具名称' 的方式来调用 Typesense MCP Server 提供的工具，例如 '@check_typesense_health' 可以检查 Typesense 服务器的健康状态。具体的工具和参数请参考 'main.py' 中的工具函数定义。

关键词