🚀 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 文件。