McpDocs
by josiahdahl
McpDocs provides documentation about your Elixir project's functions and functions of dependencies to an LLM through an SSE MCP server. It allows you to expose your Elixir project's documentation to LLMs.
Last updated: N/A
What is McpDocs?
McpDocs is an SSE MCP server that provides documentation about your Elixir project's functions and functions of dependencies to an LLM. It allows an LLM to access and utilize the documentation of your Elixir project and its dependencies.
How to use McpDocs?
- Add
mcp_docsas a dependency to your Elixir project. - Start the SSE server using
mix mcp_docs.start(optionally specifying a port with--port). - Use
npx @modelcontextprotocol/inspectorto interact with the server and access the documentation.
Key features of McpDocs
Provides documentation to LLMs
SSE MCP server
Easy installation
Simple usage
Supports custom ports
Use cases of McpDocs
Enhance LLM understanding of Elixir code
Provide context to LLMs for code generation
Enable LLMs to answer questions about Elixir projects
Improve LLM code completion
Automated documentation access for LLMs
FAQ from McpDocs
What is an SSE MCP server?
What is an SSE MCP server?
SSE stands for Server-Sent Events, and MCP stands for Model Context Protocol. It's a protocol for providing context to language models.
How do I specify a different port?
How do I specify a different port?
Use the --port flag when starting the server: mix mcp_docs.start --port 1234
What is @modelcontextprotocol/inspector?
What is @modelcontextprotocol/inspector?
It is a tool to try out the server on your code base.
Does it automatically recompile on changes?
Does it automatically recompile on changes?
Not yet, but automatic recompilation on changes is on the roadmap.
Can it look up module documentation?
Can it look up module documentation?
Looking up module documentation is on the roadmap.