droost_module_docs

Droost: Module Docs

droost_module_docs Read-only

Module: Droost core

Searches the documentation that ships ON DISK with the installed modules — READMEs, api files, docs dirs — so answers match the exact installed versions. Use it before reaching for (potentially stale) web knowledge.

Example call

{
    "tool": "droost_module_docs",
    "arguments": {
        "module": "droost",
        "query": "views"
    }
}

Example response — captured live on this site

{
    "success": true,
    "message": "droost: README.md (contrib).",
    "data": {
        "module": "droost",
        "scope": "contrib",
        "path": "modules/contrib/droost",
        "file": "README.md",
        "content": "**Droost** gives AI coding agents structured, first-hand knowledge of *this*\nDrupal application. It is the Drupal analog of\n[Laravel Boost](https://github.com/laravel/boost): a developer-acceleration\ntoolkit that exposes the application and codebase itself — versions, the entity\nand configuration model, routes, services, logs, database schema, and a set of\nguarded operations — as [Model Context Protocol](https://modelcontextprotocol.io)\n(MCP) tools.\n\nIt is built entirely on\n[MCP Server](https://www.drupal.org/project/mcp_server) and the official\n[`mcp/sdk`](https://github.com/modelcontextprotocol/php-sdk): MCP Server\nprovides the runtime and the `#[Tool]` plugin system; Droost provides the tools.\n\n> ⚠️ **Local development tool — never run Droost in production.** Droost is in\n> the same class as `devel`, `devel_php`, and `webprofiler`: it deliberately\n> exposes your application, can run arbitrary SQL, and (when you opt in) can run\n> arbitrary PHP. Install it with **`composer require --dev drupal/droost`** and\n> enable it only on local/trusted development environments. It does **not** try\n> to sandbox or sanitise what a trusted local a
… (truncated — run it yourself for the rest)

Reads and searches module documentation (README, *.md, *.api.php, docs/*.md, and the info description) across core, contrib, and custom modules. "module" (+ optional "file"): return that module's docs. "query": search doc contents (narrow with "scope": core, contrib, custom, all). Neither: list documented modules. Read-only.

Input schema (JSON Schema)

{
    "type": "object",
    "properties": {
        "query": {
            "type": "string",
            "description": "Case-insensitive text to search for within module documentation."
        },
        "module": {
            "type": "string",
            "description": "A module machine name; returns that module's primary doc (or the file named by \"file\")."
        },
        "file": {
            "type": "string",
            "description": "A specific doc file for \"module\", e.g. \"node.api.php\" or \"docs/overview.md\"."
        },
        "scope": {
            "type": "string",
            "enum": [
                "core",
                "contrib",
                "custom",
                "all"
            ],
            "description": "Limit to one module scope (default \"all\")."
        },
        "limit": {
            "type": "integer",
            "description": "Max items to return — searching: default 25, max 100; listing: default 200, max 2000."
        }
    }
}