Skip to content

Tool submodules

Two submodules hold Tool API tools meant for other projects. Each depends on Tool API and core only, Site Agent Pathauto on Pathauto too, so each can move upstream unchanged. Both are experimental while Tool API is in beta.

Site Agent Tool Belt

Site-building tools Tool Belt lacks. Each checks the permission of the admin screen it mirrors; tools whose module isn't installed are hidden.

Tool Does Permission
site_agent_tool_belt:display_describe Lists the fields of a form or view display, with widgets or formatters. administer TYPE form display or administer TYPE display
site_agent_tool_belt:display_component_set Shows, configures or hides one field on a form or view display. The same
site_agent_tool_belt:role_permissions_get Lists roles and their permissions. administer permissions
site_agent_tool_belt:role_permissions_set Grants and revokes permissions of a role. Destructive. administer permissions
site_agent_tool_belt:block_list Lists a theme's regions and the blocks in them. Needs Block. administer blocks
site_agent_tool_belt:block_place Places a block, or moves or changes a placed one. Needs Block. administer blocks
site_agent_tool_belt:log_entries_recent Reads the latest database log messages. Needs Database Logging. access site reports
site_agent_tool_belt:menu_tree Lists the menus, or a menu's links as a tree. administer menu
site_agent_tool_belt:menu_add Adds a menu, or changes its label and description. administer menu
site_agent_tool_belt:menu_link_set Adds or changes a menu link, a content entity. Needs Menu Link Content. administer menu
site_agent_tool_belt:view_describe Lists a view's displays and one display's filters, sorts, fields and pager. Needs Views. administer views
site_agent_tool_belt:view_display_edit Adds, changes or removes one filter, sort or field of an existing display, or changes its pager. Needs Views. administer views
site_agent_tool_belt:view_clone Copies a view; the copy stays disabled while a display has a path. Needs Views. administer views

No tool builds a view from scratch: a new view starts as a clone.

The configuration-writing tools extend ConfigToolBase, which checks the site_agent_tool_belt.config_write_gate service in both access() and execute() and reports a Config Read-only refusal as a failed call. On its own the gate locks writes where Config Read-only is active; with Site Agent installed, the service follows the structure gate instead.

Site Agent Pathauto

Tool Does Permission
site_agent_pathauto:pattern_list Lists the URL alias patterns and the pattern types. administer pathauto
site_agent_pathauto:pattern_set Adds a pattern, or changes its label, pattern, bundles, weight or status. administer pathauto

site_agent_pathauto:pattern_set checks the site_agent_pathauto.config_write_gate service the same way.