Skip to main content
Glama
Longman006

RibbonSmith

by Longman006

Add a button (declarative)

ribbon_add_button

Add a button with its command, labels, and display/enable rules to a Dynamics 365 ribbon in a single declarative call, generating schema-correct XML.

Instructions

Add a button with its command, rules and labels to the local working copy in one declarative call. The server generates schema-correct XML with proper id conventions, $LocLabels:/$webresource: prefixes and element order. Requires ribbon_checkout first. Get the location from ribbon_get_structure (a group id + '.Controls._children').

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYesUnique button id, convention: <publisherprefix>.<entity>.<Name>.Button, e.g. new_.account.Approve.Button
labelYesButton label (LCID 1033)
actionNoWhat the command does when the button is clicked.
entityYesEntity 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.
commandNoReuse an EXISTING command id instead of creating one (omit 'action' when set)
image16NoWeb resource name for 16x16 icon (classic)
image32NoWeb resource name for 32x32 icon (classic)
tooltipNo
locationYesCustomAction Location, e.g. 'Mscrm.Form.account.MainTab.Save.Controls._children' to append into a group
sequenceNoPosition among siblings; OOTB controls are spaced by 10. Default 100.
enableRulesNo
environmentNoDataverse environment URL, e.g. https://myorg.crm4.dynamics.com. Optional when the RIBBON_MCP_ENV_URL environment variable is set.
modernImageNoUnified Interface icon name (e.g. 'Add') or SVG web resource
displayRulesNo
templateAliasNoLayout slot of the target group (see group.template in ribbon_get_structure). Default 'o1'.
labelTranslationsNoExtra label translations: { '1031': 'Genehmigen' }
tooltipDescriptionNo
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Discloses that the server generates schema-correct XML with id conventions and prefixes, and that the operation targets the local working copy, implying a checkout/publish workflow. No annotations exist, so this context is valuable, though it omits error behavior and mutability details.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Three dense sentences: purpose, server behavior, prerequisites/location. No filler.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Covers the essential workflow (checkout, get location, add) and server-side XML generation, making it understandable for an agent. Missing return value and formal alternative guidance, but given rich schema, it is reasonably complete.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema covers 76% of parameters; description adds the crucial guidance that location comes from ribbon_get_structure as a group id + '.Controls._children', and clarifies label/webresource prefixing. This compensates for the most complex parameter without duplicating schema.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

Clearly states it adds a button with command/rules/labels declaratively, and distinguishes from sibling tools by focusing on adding vs customizing/hiding. The phrase 'one declarative call' clarifies the abstraction level.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Mentions prerequisite 'Requires ribbon_checkout first' and instructs to get location from ribbon_get_structure, giving clear context for when to invoke. However, it does not explicitly name alternatives or conditions where another sibling tool (e.g., ribbon_customize_command) should be used.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/Longman006/ribbonsmith'

If you have feedback or need assistance with the MCP directory API, please join our Discord server