McpDocs

McpDocs

site icon
2025.03.07 3
Elixir文档服务Elixir 开发工具开发效率
McpDocs 是一个为 Elixir 项目提供文档服务的工具,它通过 SSE MCP 服务器将项目函数及其依赖项的文档提供给大型语言模型(LLM)。该工具旨在帮助开发者更高效地管理和查询项目文档,提升开发效率。
View on GitHub

Overview

基本能力

产品定位

McpDocs 是一个文档服务工具,专注于为 Elixir 项目提供函数和依赖项的文档管理,并通过 SSE MCP 服务器与 LLM 交互。

核心功能

  1. 提供 Elixir 项目函数及其依赖项的文档服务。
  2. 通过 SSE MCP 服务器与 LLM 交互。
  3. 支持自定义端口启动服务。
  4. 支持手动重新编译代码。

适用场景

  1. 开发者在 Elixir 项目中需要快速查询函数或依赖项的文档。
  2. 需要将项目文档集成到 LLM 中进行进一步处理或分析。
  3. 开发或测试环境中需要动态加载和查询文档。

工具列表

  1. mix mcp_docs.start:启动 SSE 服务器,默认端口为 9702。
  2. npx @modelcontextprotocol/inspector:用于在代码库中测试 McpDocs 功能。

常见问题解答

  1. 如何启动服务? 使用 mix mcp_docs.start 命令启动服务,默认端口为 9702。
  2. 如何指定端口? 使用 --port 参数指定端口,例如 mix mcp_docs.start --port 1234
  3. 如何手动重新编译代码? 使用 iex -S mix mcp_docs.start 命令启动服务,并允许手动重新编译代码。

使用教程

使用依赖

安装 McpDocs 前,确保已安装 Elixir 和 Mix。

安装教程

在 Elixir 项目的 mix.exs 文件中添加以下依赖:

def deps do
  [
    {:mcp_docs, github: "josiahdahl/mcp_docs", runtime: false, only: [:test, :dev]}
  ]
end

然后运行 mix deps.get 安装依赖。

调试方式

  1. 启动服务: sh mix mcp_docs.start 或指定端口: sh mix mcp_docs.start --port 1234
  2. 使用 npx @modelcontextprotocol/inspector 测试功能。
  3. 如需手动重新编译代码,使用: sh iex -S mix mcp_docs.start

许可证

None