McpDocs

What is McpDocs?

McpDocs is an Elixir library that serves documentation about your Elixir project's functions and its dependencies to an LLM (Large Language Model) through an SSE (Server-Sent Events) MCP (Model Context Protocol) server. It is intended for Elixir developers who want to give AI assistants contextual knowledge of their codebase.

How to use McpDocs?

Add {:mcp_docs, github: "josiahdahl/mcp_docs", runtime: false, only: [:test, :dev]} to your mix.exs dependencies. Then run mix mcp_docs.start (optionally with --port <port>, default 9702) to start the SSE server. You can also use iex -S mix mcp_docs.start for manual recompiling. Try it out with npx @modelcontextprotocol/inspector.

Key features of McpDocs

• Serves Elixir function documentation through an SSE MCP server.
• Provides docs for both project and dependency functions.
• Easy startup via Mix task with configurable port.
• Works with the Model Context Protocol inspector tool.

Use cases of McpDocs

• Enhance an LLM’s ability to understand and use your Elixir codebase.
• Provide contextual documentation during AI-assisted development sessions.
• Enable AI tools to answer questions about function signatures and behaviours.

FAQ from McpDocs

What kind of documentation does McpDocs serve?

It serves documentation about your Elixir project’s functions and the functions of its dependencies.

How is the server started and connected to?

Run mix mcp_docs.start; the SSE server listens by default on port 9702. An LLM client can connect to that endpoint.

What are the runtime requirements?

The package should be added with runtime: false and only: [:test, :dev], meaning it is not needed in production.

What transport does McpDocs use?

It uses Server-Sent Events (SSE) as the MCP transport.

Does McpDocs support authentication or recompilation?

No authentication is mentioned, and automatic recompilation is on the roadmap but not yet implemented.