Hexdocs Fetcher

What it does

The hexdocs-fetcher skill retrieves and parses documentation from Elixir HexDocs. It allows AI agents to access information about Elixir modules, functions, and types directly from the official documentation source. This enables agents to understand and explain Elixir code more effectively.

When to use it

• Understanding Elixir Code: When an agent needs to comprehend what a specific function or module does within an Elixir project.
• Explaining Error Messages: To provide context for Elixir error messages by fetching relevant documentation about the functions involved.
• Code Generation Assistance: When generating Elixir code, the skill can be used to ensure that generated code aligns with documented APIs and best practices.
• Learning Elixir: For agents assisting users learning Elixir, providing direct access to HexDocs is a valuable resource.

Key capabilities

• Fetches documentation from Elixir HexDocs.
• Parses the fetched content for structured information.
• Provides access to module, function, and type definitions.

Example prompts

• "What does the String.length/1 function do?"
• "Show me the documentation for the Ecto.Repo module."
• "Explain how to use the Phoenix.PubSub API."

Tips & gotchas

The skill relies on a stable HexDocs structure; changes in Elixir's documentation format may require updates to the skill. Ensure the agent has network access to reach the HexDocs servers.