Integrations
Integrates with dotenv for environment variable management, specifically for Meilisearch connection configuration including host, API key, and timeout settings.
Uses Express for the web server component that hosts the MCP server implementation, enabling the StreamableHTTP transport for communication between clients and the Meilisearch API.
Employs Lerna for workspace management across the MCP server components that provide Meilisearch integration.
MCP 美丽搜索 API 服务器
模型上下文协议 (MCP) 服务器实现,使用 StreamableHTTP 传输在 AI 模型和 Meilisearch 搜索引擎之间架起桥梁。该项目支持将 Meilisearch 强大的搜索功能无缝集成到 AI 工作流中。
更新概述
该项目提供了一个 MCP 服务器,使 AI 模型能够直接与美丽搜索功能交互。其架构包括:
- MCP 服务器:使用模型上下文协议将 Meilisearch API 作为工具公开。
- Web 客户端演示:展示搜索功能的演示界面。
主要特点
- StreamableHTTP Transport :客户端和服务器之间的实时通信。
- Meilisearch API 支持:完全访问 Meilisearch 功能。
- 增强的错误处理:改进了 API 请求的错误管理。
- Web 客户端演示:更新了用于演示搜索功能的界面。
工具类别
MCP 服务器将 Meilisearch API 分为以下几类:
- 系统工具:健康检查、版本信息、服务器统计。
- 索引工具:管理索引(创建、更新、删除、列出)。
- 文档工具:添加、更新、删除和检索文档。
- 搜索工具:高级搜索,包括矢量搜索。
- 设置工具:配置索引设置。
- 任务工具:管理异步任务。
- 矢量工具:实验性的矢量搜索功能。
入门
先决条件
- Node.js v20 或更高版本。
- 正在运行的 Meilisearch 实例(本地或远程)。
- Meilisearch 的 API 密钥(如果需要)。
设置说明
- 克隆存储库:
Copy
- 安装依赖项:
Copy
- 配置环境:
创建一个包含以下内容的.env
文件:
Copy
运行服务器
要启动服务器:
Copy
访问Web界面
在浏览器中访问以下网址:
Copy
发展
该项目使用:
- TypeScript :确保类型安全。
- Express :为 Web 服务器提供支持。
- 模型上下文协议 SDK :促进 AI 集成。
选项
Meilisearch 连接选项
meilisearchHost
:Meilisearch 实例的 URL(默认值:“ http://localhost:7700 ”)meilisearchApiKey
:用于通过 Meilisearch 进行身份验证的 API 密钥(默认值:“”)
MCP 服务器选项
transport
:MCP 服务器的传输类型(“http” | “stdio”)(默认值:“http”)httpPort
:MCP 服务器的 HTTP 端口(默认值:8080)mcpEndpoint
:MCP 端点路径(默认值:“/mcp”)
会话选项
sessionTimeout
:会话超时(以毫秒为单位)(默认值:3600000)sessionCleanupInterval
:会话清理间隔(以毫秒为单位)(默认值:60000)
使用 MCPClient
该包还导出了 MCPClient 类用于客户端集成:
Copy
Related MCP Servers
- Gozlib License
- TypeScriptGPL 3.0
- PythonApache 2.0
- GoMIT License