mcp-bevy-buddy

MCP Bevy Buddy provides local Bevy examples and source inspection capabilities by reading your Cargo.toml to detect the Bevy version and then exposing access to Bevy examples from your local cargo registry. It offers a structured file tree of available Bevy examples, the ability to read contents of specific example files with proper formatting, and an option to resolve absolute paths to those files for direct access. Use it to explore Bevy projects locally, inspect example code, and verify which Bevy version your project is using. The included tools include bevy-examples for listing and browsing examples, bevy-example-read for viewing file contents, and bevy-example-absolute-path for obtaining exact file locations.

Prerequisites:

• Node.js 18+ (for running the MCP server via npx)
• npm (or pnpm/yarn if you prefer)

Installation steps:

1. Install the MCP Bevy Buddy package (example usage shown in repository): npm install mcp-bevy-buddy

2. Ensure your environment has access to your local Cargo registry and that Cargo.toml in your Bevy projects references Bevy dependencies. This server reads Cargo.toml to detect Bevy versions, so a valid cargo registry setup is required.

3. Run the MCP server via the provided command (as used in the MCP configuration): npx bevy-buddy

4. Connect your MCP client configuration using the mcp_config example provided in the README to enable the bevy-buddy server.

Tips:

• Make sure your local Cargo registry is accessible and contains a Bevy source, otherwise Bevy version detection may fail.
• The bevy-examples tool returns a structured tree; navigate using the provided paths to read or fetch absolute file locations.
• If you update Bevy dependencies in your project, re-run the server to refresh the detected Bevy version.
• Common issues include missing Cargo.toml Bevy entries or inaccessible local cargo registry; verify paths and permissions.
• This MCP server relies on npx to invoke the package; ensure npm can resolve the bevy-buddy package in your environment.