Get composed ribbon structure
ribbon_get_structureRetrieve the fully composed ribbon for a Dynamics 365 entity as a JSON tree. Filter by location and tab/group to get ground-truth ids, commands, labels, and sequence placement for customizations.
Instructions
Return the entity's fully composed ribbon (base + all customizations) as a compact JSON tree of tabs, groups and controls with ids, commands, labels, sequences and template aliases. This is the ground truth for valid Location values ('.Controls._children'), ids to hide, commands to reuse, and sequence placement. Filter by location and optionally by tab/group id to keep output small.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| tabId | No | Only return this tab (exact id) | |
| entity | Yes | Entity logical name (e.g. 'account'), or 'APPLICATION' for the application ribbon. Note: APPLICATION support is EXPERIMENTAL (implemented per documented schema but not yet covered by the live end-to-end test suite) — take extra care and keep the backup ids at hand. | |
| groupId | No | Only return the tab/groups containing this group id | |
| refresh | No | Bypass the cached ribbon and re-retrieve from the server | |
| location | No | Ribbon surface: Form (record form), HomepageGrid (main grid), SubGrid, or All. | All |
| environment | No | Dataverse environment URL, e.g. https://myorg.crm4.dynamics.com. Optional when the RIBBON_MCP_ENV_URL environment variable is set. |