Meilisearch Documentation MCP

Meilisearch文档MCP服务器

一个生产就绪的模型上下文协议（MCP）服务器，它将Meilisearch文档作为LLM的结构化工具、资源和提示公开。

特性

• 全文搜索 在所有Meilisearch文档中
• 资源访问 到各个文档页面
• 提示模板 用于常见文档查询
• 局部索引 用于快速、确定的搜索
• 自动存储库管理 使用缓存

安装

pip install -e .

或者直接安装依赖项：

pip install mcp mistune python-frontmatter whoosh GitPython pydantic

用法

运行MCP服务器

python -m meilisearch_docs_mcp

服务器将：

1. 克隆Meilisearch文档存储库（如果尚未缓存）
2. 解析所有MDX文件
3. 构建本地搜索索引
4. 在stdio上启动MCP服务器

配置

服务器可以通过环境变量进行配置：

• MEILISEARCH_DOCS_REPO_URL：存储库URL（默认值： https://github.com/meilisearch/documentation.git)
• MEILISEARCH_DOCS_CACHE_DIR：克隆仓库的缓存目录（默认： .cache/docs)
• MEILISEARCH_DOCS_INDEX_DIR：搜索索引目录（默认： .cache/index)

MCP集成

对于光标

添加到光标MCP设置（通常在 .cursor/mcp.json 或光标设置）：

{
  "mcpServers": {
    "meilisearch-docs": {
      "command": "python",
      "args": ["-m", "meilisearch_docs_mcp"],
      "env": {}
    }
  }
}

适用于克劳德桌面

增添 ~/Library/Application Support/Claude/claude_desktop_config.json （macOS）或 %APPDATA%\Claude\claude_desktop_config.json （Windows）：

{
  "mcpServers": {
    "meilisearch-docs": {
      "command": "python",
      "args": ["-m", "meilisearch_docs_mcp"]
    }
  }
}

注： 如果Python解释器的完整路径不在path中，请确保使用它，例如：

{
  "mcpServers": {
    "meilisearch-docs": {
      "command": "/usr/local/bin/python3",
      "args": ["-m", "meilisearch_docs_mcp"]
    }
  }
}

对于ChatGPT

通过ChatGPT界面中的MCP设置进行配置。服务器使用MCP协议通过stdio进行通信。

可用工具

• search_documentation(query: str, limit: int = 10) -使用查询字符串搜索文档
• get_documentation_section(section: str) -从特定部分获取所有页面（指南/参考/学习）
• list_documentation_sections() -列出所有可用的文档部分

可用资源

资源可以通过URI模式访问： meilisearch-docs://{path}

示例：

• meilisearch-docs://guides/getting_started/quick_start_guide.mdx
• meilisearch-docs://reference/api/search.mdx

可用提示

• get_started -开始使用Meilisearch
• api_reference -查询API参考文档
• troubleshooting -解决常见问题
• integration_guide -查找特定于集成的指南

发展

# Clone the repository
git clone 
cd meilisearch-documentation-mcp

# Install in development mode
pip install -e .

# Or install dependencies directly
pip install mcp mistune python-frontmatter whoosh GitPython pydantic

# Run the server
python -m meilisearch_docs_mcp

运作原理

1. 库管理：第一次运行时，服务器将Meilisearch文档存储库克隆到本地缓存目录(.cache/docs/meilisearch-documentation).

1. 解析：解析所有MDX文件以提取：

- Frontmatter元数据（标题、描述等） - Markdown内容 - 章节分类（指南/参考/学习）

1. 索引：本地Whoosh全文搜索索引是根据解析后的文档构建的，存储在 .cache/index/meilisearch_docs.

1. MCP服务器：服务器公开：

- 工具：搜索和查询文档 - 资源：通过URI访问单个文档页面 - 提示：用于常见文档查询的预配置提示

故障排除

找不到索引错误

如果您看到索引不存在的错误，服务器将自动重建它。首次运行时可能需要几分钟。

存储库克隆失败

• 检查您的互联网连接
• 验证存储库URL是否可访问
• 确保您在缓存目录中具有写入权限
• 尝试删除 .cache/docs/meilisearch-documentation 并重新启动

搜索未返回任何结果

• 验证索引是否已成功构建（检查日志）
• 尝试通过删除来重建索引 .cache/index/meilisearch_docs
• 检查MDX文件是否正确解析

许可证

麻省理工学院