基本能力
产品定位
HexDocs MCP 旨在为开发者和 AI 应用提供高效的 Hex 包文档语义搜索能力,优化开发流程和文档检索效率。
核心功能
- 文档处理与嵌入向量生成:通过 Elixir 包下载、处理 Hex 包文档并生成嵌入向量。
- 语义搜索接口:通过 TypeScript MCP 服务器提供语义搜索功能。
- 多客户端兼容:支持与 MCP 兼容的客户端(如 Cursor、Claude Desktop App、Continue 等)集成。
- 自定义配置:支持自定义存储路径和嵌入模型。
适用场景
- 开发文档检索:快速查找 Hex 包文档中的相关内容。
- AI 辅助开发:为 AI 工具提供文档上下文,优化代码生成和建议。
- 团队协作:统一团队文档检索流程,提高开发效率。
工具列表
- Elixir 包:处理 Hex 文档并生成嵌入向量。
- TypeScript MCP 服务器:提供语义搜索接口。
- Ollama:用于生成嵌入向量(需安装
nomic-embed-text
模型)。
常见问题解答
- 依赖问题:确保
floki
等依赖在:dev
环境中可用。 - Ollama 配置:需运行
ollama pull nomic-embed-text
并确保 Ollama 服务运行。 - 存储路径:默认存储在
~/.hexdocs_mcp
,可通过HEXDOCS_MCP_PATH
环境变量自定义。
使用教程
使用依赖
- 安装 Ollama:
bash
# 下载并安装 Ollama
curl -fsSL https://ollama.ai/install.sh | sh
# 拉取嵌入模型
ollama pull nomic-embed-text - 安装 Elixir 1.16+ 和 Node.js 22+。
安装教程
- 安装 Elixir 包:
elixir
{:hexdocs_mcp, "~> 0.1.1", only: :dev, runtime: false} - 配置 MCP 客户端:
json
{
"mcpServers": {
"hexdocs-mcp": {
"command": "npx",
"args": ["-y", "hexdocs-mcp"]
}
}
}
调试方式
- 获取文档并生成嵌入向量:
bash
mix hex.docs.mcp fetch phoenix - 搜索文档内容:
bash
mix hex.docs.mcp search --query "channels" phoenix - 使用特定嵌入模型:
bash
mix hex.docs.mcp fetch --model all-minilm phoenix