protonsystems / site-audit
Drupal 11 site inventory with a semantic JSON model and interactive architecture dashboard.
Package info
gitlab.com/Proton.Systems/drupal/site-audit
Type:drupal-module
pkg:composer/protonsystems/site-audit
Requires
- php: ^8.3
- drupal/core: ^11
Requires (Dev)
None
Suggests
- protonsystems/site-audit-mcp: Optional MCP adapter for Site Audit Tools.
- protonsystems/site-audit-tools: Optional Drupal Tool API integration for Drupal AI Agents and MCP.
Provides
None
Conflicts
None
Replaces
None
README
Site Audit exposes a renderer-independent JSON description of a Drupal site, including its installed module inventory, languages, configuration collection counts, content model, roles, text formats, editor configurations, and configured entity-reference relationships.
Install
composer require protonsystems/site-audit
drush en site_audit
Read the model
The authenticated JSON endpoint is available at /admin/reports/site-audit/model.json. It requires the restricted Drupal permission view site audit model and does not include individual content or user records. Grant that permission to a dedicated integration role when an authenticated bot needs the HTTP endpoint.
For local integrations and bots with access to Drush, print the same contract to standard output:
drush site-audit:model --pretty
The JSON contract is described in docs/model-json.md. The architecture and extension points are in docs/module-architecture.md.
Optional agent integrations are separate Composer packages: protonsystems/site-audit-tools provides Tool API support, and protonsystems/site-audit-mcp adds MCP on top of Tools. Neither integration adds dependencies to this base package.
The interactive inventory is available at /admin/reports/site-audit to users with the View site audit model permission. Its Content types panel lists node bundles and shows each field's type, required status, cardinality, translation status, storage kind, and reference target. The same permission protects the JSON endpoint at /admin/reports/site-audit/model.json.
The site-audit-model/1.4.0 contract also includes field and storage settings, literal defaults, validation constraints, form widgets, view formatters, and separate base/configurable field counts. Summary counts distinguish entity form displays, entity view displays, and displays configured inside Views. It describes configured widgets and displays only; it does not render forms or load content records. Aggregate usage queries are provided by the optional Tools package so ordinary dashboard and JSON requests stay configuration-only.
Design boundary
The collector describes Drupal's configured site inventory and field relationships in a renderer-independent JSON model. The administration dashboard turns that model into an interactive Cytoscape.js graph, module inventory, and language/configuration overview. Cytoscape.js is shipped locally with the module; no CDN is required. Optional integration packages consume the same collector contract without adding dependencies to the base package.
Publishing a release
Packagist versions are published from annotated Git tags; do not add a version field to composer.json. Commit the release on main, then create and push its tag:
git tag -a vX.Y.Z -m "Release vX.Y.Z"
git push origin main vX.Y.Z
Use semantic versioning and verify that Packagist lists the new tag after pushing.
Last verified: 2026-11-18