Skip to main content
Glama
Dynamics 365 MCP Server

Dynamics 365 MCP Server

by Kenny-666

get_model_relationship

Read-only

Retrieves a native Dynamics 365 relationship definition by schema name and returns it as 1:N or N:N metadata, without inferring publication status or UI placement.

Instructions

Read a native relationship definition by schema name, cast to 1:N or N:N metadata. Does not infer publication or UI placement.

Input Schema

NameRequiredDescriptionDefault
schemaNameNo
schema_nameNo
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

B3.4/5.0
Behavior3/5

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

readOnlyHint=true already tells the agent this is a safe read, so the bar is lower. The description adds a genuinely useful boundary — the result is the native definition only, with no publication state or UI placement inferred — but says nothing about permissions, failure modes, or what the returned metadata block contains.

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

Conciseness4/5

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

Two short sentences, front-loaded with the action and resource, and the exclusions follow immediately. No filler; the only mild cost is jargon ('cast to ... metadata') that an unfamiliar agent may need to parse.

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

Completeness3/5

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

For a simple read-only lookup with no output schema, the description covers the essential contract but stops short of describing what the 1:N/N:N metadata payload contains or what happens when the relationship name does not exist. Adequate without being complete.

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 description coverage is only 33%, with environment_profile the sole documented parameter. The phrase 'by schema name' does identify the driving identifier and helps disambiguate the schemaName/schema_name alias pair, but the alias relationship, the name pattern, and the default-environment behavior are left to the schema.

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

Purpose4/5

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

States a specific verb ('Read') and resource ('native relationship definition') plus the lookup key ('by schema name') and the shape of what comes back ('1:N or N:N metadata'). An agent can distinguish it from create_model_relationship and update_model_relationship, though no sibling is named explicitly.

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

Usage Guidelines3/5

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

The clause 'Does not infer publication or UI placement' implicitly signals that callers wanting UI/publish context should look at the UI-component or sitemap tools, but no alternative is named and no explicit when-to-use condition is given. Usage is only implied through the negative-scope statement.

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