Drupal Scout

Search for Drupal module entries with transitive core version requirements to help to upgrade the Drupal Core.

Installation

Using uv (Recommended)

uv tool install drupal-scout

Or run directly without installing:

uvx drupal-scout --help

Using pip

pip install drupal-scout

Quick Start

Get a compatibility report for your current Drupal project:

drupal-scout

Scan a specific module for Drupal 11 compatibility:

drupal-scout --core 11.0.0 --modules drupal/webform

Features

• Asyncio Concurrency: High-performance parallel module scanning using asyncio to speed up dependency analysis.
• Rich TUI Integration: Beautiful terminal output with structured tables and real-time progress bars powered by the rich library.
• MCP Server Support: Built-in Model Context Protocol server for integration with AI IDEs (like Claude Desktop or Cursor).
• Environment Diagnostics: Quick self-diagnostic check of the environment and dependencies using the info command.
• Multiple Output Formats:
  • table: High-fidelity color-coded table for human readability.
  • json: Machine-readable raw data for automation scripts.
  • suggest: Generates a suggested composer.json with updated version requirements.

Limitations

• Python 3.11+: The application requires Python 3.11 or higher.
• Composer v2: The application works with Composer-based (Composer v2) Drupal 8+ projects.

Usage/Examples

drupal-scout [-h] [-v] [-d DIRECTORY] [-n] [-l LIMIT] [-f {table,json,suggest}] [-s] [-c CORE] [-m MODULES [MODULES ...]] {info} ...

Arguments

• -h, --help: Show help message and exit.
• -v, --version: Show program's version number and exit.
• -d DIRECTORY, --directory DIRECTORY: Directory of the Drupal installation (default: .).
• -n, --no-lock: Do not use the composer.lock file to determine installed versions.
• -l LIMIT, --limit LIMIT: Concurrency limit for async requests. Default is 10.
• -f {table,json,suggest}, --format {table,json,suggest}: Output format (default: table).
• -s, --save-dump: Use with --format suggest to save the suggested composer.json to disk.
• -c CORE, --core CORE: Optional Drupal core version override (e.g., 10.0.0).
• -m MODULES [MODULES ...], --modules MODULES [MODULES ...]: Scan only specific modules, skipping full project discovery.
• --deep-scan[=MODE]: Perform a read-only local deep scan for global or targeted scans. Optional mode: all (default, Git + Patches), patches (Composer patches only), or git (Git index + history only).

Subcommands

• info: Show diagnostic information about the tool, jq availability, and the current Drupal environment.

MCP Server Usage

To run drupal-scout as an MCP server for AI coding assistants:

drupal-scout-mcp

Or with uvx:

uvx --from drupal-scout drupal-scout-mcp

Quick Configuration for Claude Desktop (claude_desktop_config.json)

{
  "mcpServers": {
    "drupal-scout": {
      "command": "uvx",
      "args": ["--from", "drupal-scout", "drupal-scout-mcp"]
    }
  }
}

For complete setup guides across Claude Desktop/Code, GitHub Copilot, Google Antigravity, and OpenAI Codex, see the detailed MCP Connection Guide.

Deep Scan & Audit Examples

Perform a complete deep scan across all project modules (global scan):

drupal-scout --deep-scan

Perform a Composer patch-only scan:

drupal-scout --deep-scan=patches

Perform a Git audit scan for targeted modules:

drupal-scout --directory /path/to/drupal --modules drupal/webform drupal/workbench --deep-scan=git

Perform a deep scan and output JSON:

drupal-scout --directory /path/to/drupal --deep-scan --format json