HexDocs MCP Server

HexDocs MCP Server

site icon
2025.04.03 0
JavaScript语义搜索文档管理开发效率
HexDocs MCP Server 是一个基于 TypeScript 的服务器,实现了模型上下文协议(MCP),为 Hex 包文档提供语义搜索功能。它设计用于与 [hexdocs_mcp](https://github.com/bradleygolden/hexdocs-mcp) Elixir 包生成的嵌入无缝协作,使得 Hex 文档在 AI 应用中易于搜索。
View on GitHub

Overview

基本能力

产品定位

HexDocs MCP Server 是一个专为 Hex 包文档设计的语义搜索服务器,旨在通过 MCP 协议与 AI 工具集成,提升开发效率。

核心功能

  • 实现 MCP 协议的服务器,支持 Hex 包文档的语义搜索
  • hexdocs_mcp Elixir 包生成的嵌入集成
  • 基于模型上下文协议标准,兼容多种 AI 工具
  • 通过 npx 快速安装
  • 支持自定义数据库路径

适用场景

  • 开发者在 AI 应用中快速搜索 Hex 包文档
  • 需要与 MCP 兼容的 AI 工具集成的场景
  • 提升开发效率,减少手动查找文档的时间

工具列表

  • hexdocs_mcp Elixir 包:生成 Hex 包文档的嵌入,供 MCP 服务器使用

常见问题解答

  • 如何指定自定义数据库路径? 通过设置环境变量 HEXDOCS_MCP_PATH 可以指定自定义数据库路径。
  • 如何集成到 AI 工具中? 在 mcp.json 中添加相应的配置,指定命令和参数即可。

使用教程

使用依赖

  • Node.js 18 或更高版本
  • 访问由 hexdocs_mcp 生成的 SQLite 数据库(需要先运行 mix hex.docs.mcp fetch PACKAGE 获取所需包的文档)

安装教程

npx -y hexdocs-mcp-server

调试方式

  1. 确保 Node.js 版本符合要求
  2. 检查 HEXDOCS_MCP_PATH 环境变量是否设置正确
  3. 运行服务器并检查日志输出
npx -y hexdocs-mcp-server

许可证

该项目遵循 MIT 开源许可条款,请参阅 MIT 了解完整条款。