Hexdocs MCP Server

🚀 HexDocs MCP Server

A Model Context Protocol (MCP) server implemented in TypeScript that provides semantic search functionality for Hex package documentation. It seamlessly integrates with the embedded data generated by the hexdocs_mcp Elixir package, making Hex documentation easily searchable in AI applications.

🚀 Quick Start

The HexDocs MCP Server is a powerful tool for searching Hex package documentation. It's easy to set up and integrate with various AI tools.

✨ Features

• MCP-compatible Server: Designed for searching Hex package documentation.
• Data Integration: Integrates with the embedded data generated by hexdocs_mcp.
• AI Tool Compatibility: Based on the Model Context Protocol standard, it's compatible with AI tools.
• Quick Installation: Can be quickly installed via npx with simple setup.
• Custom Configuration: Supports custom configuration of the database path.

📦 Installation

Compatibility Requirements

• Node.js 18 or higher.
• Access to the SQLite database generated by hexdocs_mcp. You need to run mix hex.docs.mcp fetch PACKAGE first to get the data for the required packages.

Configuration

The server looks for the SQLite database created by the hexdocs_mcp package. By default, it uses ~/.hexdocs_mcp/hexdocs_mcp.db, but you can specify a custom path:

# Example: Set a custom database path
export HEXDOCS_MCP_PATH=/path/to/custom/directory

💻 Usage Examples

Integration with AI Tools

The server can be integrated with various AI tools that support the Model Context Protocol. Here is an example for Cursor:

Add the following content to your mcp.json file:

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

Tips and Tricks

💡 Usage Tip

When you interact with an agent and find that the documentation for a specific tool is missing, you can ask the AI to run the mix hex.docs.mcp fetch ... command to get the required data for you.

🤝 Contribution

Contributions are welcome! Please feel free to submit pull requests. For major changes, please open an issue first to discuss what you would like to change.

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.