a year ago
developer-toolsProvide documentation about your Elixir project's functions and functions of dependencies to an LLM through an SSE MCP server.
Overview
what is McpDocs?
McpDocs is a tool that provides documentation about your Elixir project's functions and the functions of its dependencies to a language model through an SSE MCP server.
how to use McpDocs?
To use McpDocs, install it as a dependency in your Elixir project and start the SSE server using the provided commands.
key features of McpDocs?
- Provides real-time documentation for Elixir projects.
- Supports SSE (Server-Sent Events) for live updates.
- Allows for manual recompilation of code during development.
use cases of McpDocs?
- Generating documentation for Elixir projects automatically.
- Assisting developers in understanding project dependencies.
- Enhancing collaboration by providing up-to-date documentation.
FAQ from McpDocs?
- How do I install McpDocs?
You can install McpDocs by adding it to your project's dependencies in the mix.exs file.
- Can I run McpDocs on a specific port?
Yes! You can specify a port when starting the server using the --port option.
- Is McpDocs suitable for production use?
McpDocs is primarily designed for development and testing environments.