Skip to main content
Glama
Dynamics 365 MCP Server

Dynamics 365 MCP Server

by Kenny-666

edit_ribbon_solution

Preview and edit one entity's classic RibbonDiffXml in an unmanaged solution ZIP to add custom JS buttons, update labels/sequence, or hide/unhide buttons, writing a new ZIP.

Instructions

Preview by default; edit only one entity classic RibbonDiffXml in an ordinary unmanaged local ZIP. Add standalone custom JS buttons with publisher-scoped IDs, explicit current-table insertion location, ordered parameters, multilingual labels and packaged JS/raster icons; update labels/sequence; hide/unhide via a dedicated contradictory client display rule on an unshared custom command. Preserve other languages/rules/handlers, all other archive payloads and outside-Ribbon XML semantics. Execute with current planHash to write an exclusive NEW ZIP; never overwrite input, import, publish or run code. Built-in replacements, arbitrary rules, handler updates, modern commands and deployment remain separate workflows.

Input Schema

NameRequiredDescriptionDefault
dryRunNoDefault true; preview writes no file.
changesNo
dry_runNoDefault true; preview writes no file.
filePathNoAbsolute local solution ZIP path; no network/device paths.
file_pathNoAbsolute local solution ZIP path; no network/device paths.
outputPathNoAbsolute new .zip destination, required for preview and execution.
logicalNameNo
output_pathNoAbsolute new .zip destination, required for preview and execution.
expectedHashNo
logical_nameNo
contentBase64NoCanonical base64 ZIP <=32 MiB. Supply exactly one input source.
expected_hashNo
content_base64NoCanonical base64 ZIP <=32 MiB. Supply exactly one input source.
environment_profileNoOptional named environment profile for this call; omit to use the configured default.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv1.1.2
    • addedInput schema / properties / environment_profile
      Added value: +{
      +  "description": "Optional named environment profile for this call; omit to use the configured default.",
      +  "pattern": "^[A-Za-z][A-Za-z0-9_]{0,31}$",
      +  "type": "string"
      +}
  2. First observedv1.0.0

TDQS

A4.2/5.0
Behavior4/5

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

Beyond the annotations (readOnly=false, idempotent=false, destructive=false), the description discloses what is preserved (other languages, rules, handlers, other archive payloads, outside-Ribbon XML semantics) and what is never done (overwrite input, import, publish, execute code), which is exactly the mutation risk an agent needs stated. The two-phase preview-then-execute contract is mentioned but referenced as 'planHash', a name that does not match any parameter.

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

Conciseness3/5

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

Dense and information-rich with essentially no filler, but delivered as one long compound paragraph packing five or six distinct concerns into single sentences, which makes it hard to scan for the operative rule. It would benefit from being broken into purpose / constraints / exclusions.

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?

For a 14-parameter mutation tool with no output schema, it covers the core behavioral contract — preview default, output is a new ZIP, preservation guarantees, excluded workflows. Missing pieces are the input-source exclusivity rule, the hash/plan token linkage, and any statement of what a preview returns.

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?

With 64% schema description coverage, the description meaningfully supplements the schema by defining the semantics of button IDs (publisher-scoped), insertion location (explicit current table), parameter ordering, multilingual labels and packaged JS/raster icons. It does not explain the file_path-vs-content_base64 alternation, the 20-change cap, environment_profile, or how the referenced 'planHash' maps to expected_hash.

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?

States a precise verb and resource: edit one entity's classic RibbonDiffXml inside an ordinary unmanaged local ZIP, with the three supported change types (add standalone JS buttons, update labels/sequence, hide/unhide) enumerated. This clearly separates it from the sibling ribbon tools (inspect_ribbon_solution, import_ribbon_solution, publish_ribbon_solution).

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?

Explicitly names excluded workflows — built-in button replacements, arbitrary rules, handler updates, modern commands and deployment — so an agent knows what to route elsewhere, and states that invocation previews by default and only writes when executed with a current planHash. The gap is that the prerequisite discovery step (get_ribbon_definition / inspect_ribbon_solution) is never named.

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

Deploy Server

Other Tools