Hexdocs MCP Server

🚀 HexDocs MCP 服務器

本項目是一個採用 TypeScript 實現的 Model Context Protocol (MCP) 服務器，主要為 Hex 包文檔提供語義搜索功能。它能與由 hexdocs_mcp Elixir 包生成的嵌入式數據完美集成，讓 Hex 文檔在 AI 應用中輕鬆實現搜索。

🚀 快速開始

兼容性要求

• 需要 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"
      ]
    }
  }
}

✨ 主要特性

• 作為兼容 MCP 的服務器，可用於搜索 Hex 包文檔。
• 能與 hexdocs_mcp 生成的嵌入式數據集成。
• 基於 Model Context Protocol 標準，與 AI 工具兼容。
• 可通過 npx 快速安裝，且設置簡單。
• 支持自定義數據庫路徑配置。

💡 使用建議

當你與一個代理互動並發現缺少特定工具的文檔時，可以讓 AI 運行 mix hex.docs.mcp fetch ... 命令為你獲取所需數據。

🤝 貢獻

歡迎大家貢獻代碼！你可以隨意提交拉取請求。若有主要更改，請先打開問題討論你想要更改的內容。

📄 許可證

該項目遵循 MIT 許可證，有關詳細信息，請參閱 LICENSE 文件。