Skip to main content
Glama
Dynamics 365 MCP Server

Dynamics 365 MCP Server

by Kenny-666

get_model_key

Read-only

Reads one native alternate-key definition and its index state (Pending/InProgress/Active/Failed), with optional linked job details, to verify whether the key is usable for alternate-key operations.

Instructions

Read one native alternate-key definition and Pending/InProgress/Active/Failed index state. Optional linked job projection excludes free-text messages/data. A saved key is usable for alternate-key operations only after its native index is Active; no automatic reactivation.

Input Schema

NameRequiredDescriptionDefault
includeJobNo
schemaNameNo
include_jobNo
logicalNameNo
schema_nameNo
logical_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
Behavior4/5

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

With readOnlyHint=true already declaring a safe read, the description adds useful behavioral context: the possible index states (Pending/InProgress/Active/Failed), the optional linked job projection excluding free-text messages/data, and the no-automatic-reactivation rule. It does not discuss permissions or response structure, but the annotation covers the safety profile.

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?

The three sentences are front-loaded and efficient, covering purpose, projection behavior, and lifecycle constraints without filler. The second sentence is slightly cryptic because it references an optional projection without naming the includeJob parameter, but overall the structure is tight.

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 read tool with no output schema and low parameter-description coverage, the description explains the core returned state and job projection exclusion but does not fully describe the required logical/schema name inputs, aliases, or environment profile handling. It is adequate for the main concept but incomplete for reliable invocation across all parameters.

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

Parameters2/5

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

Schema description coverage is only 14%, so the description needs to compensate for the seven parameters. It only gestures at the optional linked job projection without naming includeJob, and it says nothing about logical_name, schema_name, aliases, or environment_profile selection beyond the schema itself.

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?

The description clearly states a specific read operation: retrieving one native alternate-key definition plus its index state. It distinguishes the tool from mutation siblings like create_model_key and reactivate_model_key by emphasizing read-only inspection and index-state lifecycle, though it does not explicitly name an alternative.

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 lifecycle note that a saved key is usable only after its native index is Active, and that there is no automatic reactivation, implies this tool is used to check readiness before relying on a key. However, it never explicitly says when to call this versus reactivate_model_key or other key-related tools.

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