Skip to main content
Glama
Longman006

RibbonSmith

by Longman006

Get composed ribbon structure

ribbon_get_structure

Retrieve 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

TableJSON Schema
NameRequiredDescriptionDefault
tabIdNoOnly return this tab (exact id)
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.
groupIdNoOnly return the tab/groups containing this group id
refreshNoBypass the cached ribbon and re-retrieve from the server
locationNoRibbon surface: Form (record form), HomepageGrid (main grid), SubGrid, or All.All
environmentNoDataverse environment URL, e.g. https://myorg.crm4.dynamics.com. Optional when the RIBBON_MCP_ENV_URL environment variable is set.
Behavior3/5

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

With no annotations, the description carries the transparency burden. It discloses the return format (compact JSON tree) and the concept of being the ground truth, which is helpful. Yet it does not mention caching behavior (e.g., refresh parameter bypasses cache), potential errors, or explicitly state that the operation is read-only, leaving some behavioral aspects implicit.

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?

The description is two sentences: the first defines the output and contents, the second explains utility and filtering. Every phrase earns its place with no redundancy or filler, and the key details are front-loaded.

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?

The description covers the output structure, intended use cases, and filtering options, which is sufficient for an agent to invoke the tool correctly. The schema provides detailed parameter semantics, including the experimental APPLICATION note. While no output schema exists, the description adequately characterizes the response shape; a minor gap is the lack of explicit mention of caching or error behavior, but this is not critical for a simple getter.

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

Parameters3/5

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

Schema coverage is 100%, so all parameters already have descriptions. The main description reinforces filtering by location and tab/group id, but adds no new semantic details beyond the schema. Given the baseline of 3 for full schema coverage, no further credit is warranted.

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?

The description opens with the specific verb 'Return' and the resource 'fully composed ribbon', then details the contents (tabs, groups, controls) and the output format (compact JSON tree). This clearly distinguishes it from sibling getters like ribbon_get_command, which targets a single command rather than the full structure.

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?

The description explains the tool's utility as the ground truth for valid Location values, ids to hide, commands to reuse, and sequence placement, indicating it should be used before ribbon modifications. It also gives practical advice to filter by location and tab/group id to keep output small. However, it does not explicitly compare against alternative getters like ribbon_get_diff or ribbon_get_command, so prohibitions are absent.

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