HexDocs MCP 服务器

一个实现了模型上下文协议 (MCP) 的 TypeScript 服务器，它为 Hex 包文档提供语义搜索功能。它旨在与 hexdocs_mcp Elixir 包生成的嵌入无缝协作，使 Hex 文档可以在 AI 应用程序中轻松搜索。

特性

• 兼容 MCP 的服务器，用于搜索 Hex 包文档
• 与 hexdocs_mcp Elixir 包生成的嵌入集成
• 基于模型上下文协议标准构建，与 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

集成

该服务器可以与各种支持模型上下文协议的 AI 工具集成。 这是一个 Cursor 的示例：

将其添加到您的 mcp.json：

{
  "mcpServers": {
    "hexdocs-mcp-server": {
      "command": "npx",
      "args": [
        "-y",
        "hexdocs-mcp-server"
      ]
    }
  }
}

专业提示

当您与代理互动时，并且发现您没有特定工具的给定文档时，您可以让 AI 为您运行 mix hex.docs.mcp fetch ... 命令，这样您就不必自己运行了。

贡献

欢迎贡献！ 请随时提交 Pull Request。 对于重大更改，请先打开一个 issue 来讨论您想要更改的内容。

本项目采用 MIT 许可证 - 有关详细信息，请参阅 LICENSE 文件。