HexDocs MCP 服务器

一个使用 TypeScript 实现的 Model Context Protocol (MCP) 服务器，为 Hex 包文档提供语义搜索功能。它与由 hexdocs_mcp Elixir 包生成的嵌入式数据无缝集成，使 Hex 文档在 AI 应用中易于搜索。

特性

• 兼容 MCP 的服务器，用于搜索 Hex 包文档
• 与 hexdocs_mcp 生成的嵌入式数据集成
• 基于 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，但你可以指定自定义路径：

# 示例：设置自定义数据库路径
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"
      ]
    }
  }
}

提示技巧

当你与一个代理互动并发现缺少特定工具的文档时，可以让 AI 运行 mix hex.docs.mcp fetch ... 命令为你获取所需数据。

贡献

欢迎贡献！请随意提交拉取请求。对于主要更改，请先打开问题讨论你想要更改的内容。

该项目授权 MIT 许可证 - 有关详细信息，请参阅 LICENSE 文件。