关于 HexDocs MCP Server
HexDocs MCP Server 使用 hexdocs_mcp 生成的嵌入数据和 SQLite 数据库,对 Hex 包文档进行语义搜索,适用于需要检索 Hex 文档的 AI 应用和工具。
主要功能
- 01对 Hex 文档进行语义搜索
- 02使用 hexdocs_mcp 生成的嵌入数据
- 03从 SQLite 读取文档
- 04通过 npx 安装
- 05配置自定义数据库路径
适用场景
- 01从 AI 工具搜索 Hex 包文档
- 02查找与编码任务相关的文档
- 03指定 SQLite 数据库位置
MCP 相关
该服务向兼容 MCP 的 AI 工具提供 Hex 包文档语义搜索。它使用由 hexdocs_mcp Elixir 包准备的 SQLite 数据库。
配置
本地服务的配置在各客户端中通用,复制后粘贴到客户端的 MCP 配置文件即可。
工具
本地服务需要在你的电脑上运行后才能读取工具,维护者暂未提供工具列表。
详细介绍
HexDocs MCP 服务
这是一个用 TypeScript 实现的服务器,遵循 Model Context Protocol (MCP),可为 Hex 包文档提供语义搜索功能。它旨在与 hexdocs_mcp Elixir 包生成的嵌入无缝协作,让 AI 应用轻松搜索 Hex 文档。
功能
- 兼容 MCP 的 Hex 包文档搜索服务
- 集成 hexdocs_mcp Elixir 包生成的嵌入
- 基于 Model Context Protocol 标准构建,兼容 AI 工具
- 可通过
npx轻松安装,快速完成设置 - 配置简单,可自定义数据库路径
要求
- Node.js 18 或更高版本
- 可访问由 hexdocs_mcp 生成的 SQLite 数据库(需先对所需的包运行
mix hex.docs.mcp fetch PACKAGE)
配置
服务器会查找由 hexdocs_mcp 包创建的 SQLite 数据库。默认使用 ~/.hexdocs_mcp/hexdocs_mcp.db,但你也可以指定自定义路径:
# Example: Set custom database path
export HEXDOCS_MCP_PATH=/path/to/custom/directory
集成
此服务器可以集成到各种支持 Model Context Protocol 的 AI 工具中。以下是 Cursor 的示例:
将以下内容添加到你的 mcp.json:
{
"mcpServers": {
"hexdocs-mcp-server": {
"command": "npx",
"args": [
"-y",
"hexdocs-mcp-server"
]
}
}
}
实用提示
当你和 Agent 协作时,如果发现没有某个工具对应的文档,可以让 AI 替你运行 mix hex.docs.mcp fetch ... 命令,这样你就不用自己运行了。
贡献
欢迎贡献!请随时提交 Pull Request。对于重大更改,请先创建 issue,讨论你希望进行的更改。
本项目采用 MIT 许可证,详情请参阅 LICENSE 文件。
评论
一个开放协议,规定了 AI 应用如何以统一方式连接外部工具与数据源。客户端负责与模型对话,MCP 服务负责提供工具、资源和提示模板,两者通过标准消息通信,同一个服务可以被不同客户端复用。