livewire

The Livewire MCP Server provides a structured interface for accessing Livewire documentation topics, details, and code examples. It exposes tools to list all topics, fetch details for a specific topic, retrieve usage examples, search the docs by keyword, and list documentation categories. You can use these tools to quickly surface Livewire concepts directly from the official documentation repository, with content cached locally for offline access. Once running, you can query the server via the MCP protocol (as implemented in your host integration, e.g., Augment) to retrieve: topic overviews, full markdown content for topics, categorized topic lists, and sample code snippets.

Typical interactions include asking for all topics within a category (e.g., Directives or Forms), requesting detailed information about a specific topic (like Livewire components or validation), and pulling code examples related to a topic (such as wire:model usage or form handling). The server is designed to be resilient: it caches files locally and can operate offline after the initial fetch, and it organizes topics by categories as defined in the Livewire docs.

Prerequisites:

• Node.js (v14+ recommended) with npm installed
• Git (for cloning or pulling updates)

1. Install dependencies and build the MCP server

• git clone https://github.com/benjibee/benjibee-livewire-mcp-server.git
• cd benjibee-livewire-mcp-server
• npm install
• npm run build

2. Run the MCP server locally

• Ensure you have a config that points to the built server (build/index.js)
• Start the server (example): node build/index.js

3. Integrate with your MCP client or IDE integration (e.g., Augment)

• Configure your MCP client to connect to the server using the provided mcp_config format (see JSON below).
• If using Augment, reference the server with a command like: node build/index.js

4. Optional: Set up caching and offline usage

• The server caches documentation files locally to support offline usage after the initial fetch. Ensure the cache directory has write permissions and sufficient space.

Tips and common issues:

• Ensure network access if this is the first run so the server can fetch and cache the Livewire docs from the official repository.
• If you update the documentation sources, you may need to restart the MCP server to refresh the cache.
• Use the provided category and topic listing tools to discover new topics when Livewire releases updates.
• If you encounter no response, verify that the server process is running and that the path to build/index.js in your configuration is correct.
• The server uses Markdown parsing to extract topic content and code blocks; some advanced Livewire Markdown features may require additional parsing fallback data.
• Environment variables:
  • NODE_ENV: set to production for optimized behavior; use development for debugging.
  • CACHE_DIR: path to the local cache directory; adjust per your environment.