使用说明

项目简介

HexDocs MCP Server 是一个非官方的实验性 MCP 服务器，它基于 HexDocs 的搜索 API，旨在让 AI Agent (如 Claude 或 Cursor) 能够方便地搜索 Elixir 语言包的文档。通过该服务器，AI Agent 可以调用 'search' 工具，输入 Elixir 包名和查询关键词，即可检索 HexDocs 上的相关文档内容。

主要功能点

文档搜索: 提供 'search' 工具，允许 AI Agent 搜索指定 Elixir 包的 HexDocs 文档。
工具集成: 作为一个 MCP 服务器，它以标准化的方式向 AI Agent 提供工具能力，方便集成到各种支持 MCP 协议的 LLM 应用中。
Stdio 传输: 使用 Stdio 作为传输协议，简化部署和集成过程。

安装步骤

克隆仓库:

git clone https://github.com/v0idpwn/hexdocs-mcp.git
cd hexdocs-mcp

安装依赖:
```
npm install
```
构建项目:
```
npm run build
```

服务器配置

要将 HexDocs MCP Server 添加到 MCP 客户端（例如 Claude），您需要配置服务器的启动命令和参数。以下是配置信息示例（JSON 格式），通常在 MCP 客户端的服务器管理界面中添加：

{
  "server name": "hexdocs",
  "command": "node",
  "args": [
    "/path/to/hexdocs-mcp/dist/index.js"  // 将 "/path/to/hexdocs-mcp" 替换为 hexdocs-mcp 仓库在您本地的实际路径
  ]
}

注意:

'"server name"': 服务器的名称，可以自定义，例如 "hexdocs"。
'"command"': 启动服务器的命令，这里是 'node'，因为项目是 Node.js 应用。
'"args"': 命令的参数列表，这里指向编译后的服务器入口文件 '/path/to/hexdocs-mcp/dist/index.js'。请务必将 '/path/to/hexdocs-mcp' 替换为您本地 hexdocs-mcp 仓库的实际绝对路径。

基本使用方法

配置完成后，在支持 MCP 协议的 AI Agent 中，您可以使用 'hexdocs.search' 工具来搜索 HexDocs 文档。

例如，要搜索 'phoenix' 和 'ecto' 包中关于 "router" 的文档，可以向 AI Agent 发出如下指令：

使用 hexdocs.search 工具，包名是 ["phoenix", "ecto"]，关键词是 "router"。

AI Agent 会调用 'hexdocs.search' 工具，并将搜索结果返回给您。搜索结果将包含找到的文档标题、包名、引用链接、类型以及文档内容摘要。

工具参数说明:

'hexdocs.search' 工具接受以下参数：

'packages': 要搜索的 Elixir 包名列表，例如 '["phoenix", "ecto"]'。
'query': 搜索关键词，例如 '"router"'。