mirror of
https://github.com/prowler-cloud/prowler.git
synced 2026-10-10 05:24:20 +00:00
Rubén De la Torre Vico
975c3f082d
Adds ProwlerMCP, the FastMCP subclass every sub-server is now built
from. Its tool() wraps whatever it registers -- the decorator forms and
the direct call BaseTool uses -- so a failure leaves any tool as a
ToolError, which the client reads as isError: true.
Applied at the base class rather than by hand because forgetting it is
silent: every server now sets mask_error_details=True, so an unwrapped
tool would answer "Error calling tool 'x'" and nothing else. ToolError
bypasses that masking, which is what lets the servers mask by default
and still say something useful.
No tool changes yet. Tools that still return {"error": ...} keep working
exactly as before; they are converted surface by surface in the PRs
above this one. What changes here is that a failure which used to escape
as a raw exception is now described by render_tool_error.
The rules this establishes are in AGENTS.md and the developer guide,
so the conversions have something to be checked against.
Prowler Documentation
This repository contains the Prowler Open Source documentation powered by Mintlify.
Documentation Structure
- Getting Started: Overview, installation, and basic usage guides
- User Guide: Comprehensive guides for Prowler Cloud, Prowler Local Server, Prowler CLI, providers, and compliance
- Developer Guide: Technical documentation for developers contributing to Prowler
Local Development
Install a reviewed version of the Mintlify CLI to preview documentation changes locally:
npm install --global mint@4.2.689
Run the following command at the root of your documentation (where mint.json is located):
mint dev
View your local preview at http://localhost:3000.
Publishing Changes
Changes pushed to the main branch are automatically deployed to production through Mintlify's GitHub integration.
Documentation Guidelines
When contributing to the documentation, please follow the Prowler documentation style guide located in the .claude directory.
Troubleshooting
- If your dev environment isn't running: Run
mint updateto ensure you have the most recent version of the CLI. - If a page loads as a 404: Make sure you are running in a folder with a valid
mint.jsonfile and that the page path is correctly listed in the navigation.