Skip to main content
Glama
Dynamics 365 MCP Server

Dynamics 365 MCP Server

by Kenny-666

d365_plugin_step_register

Destructive

Registers a Dynamics 365 plugin step for an existing native plugin type, resolving message/entity filters and validating duplicate signatures. Supports dry-run previews and secure configuration.

Instructions

Register a step for an existing native plugin type. Resolves message/entity filters, validates filtering fields and detects duplicate signatures. No write is automatically replayed. Optional secure configuration is allocated separately and bound in the step create; all phases report their IDs on failure. dry_run previews without writing.

Input Schema

NameRequiredDescriptionDefault
modeYes0/Synchronous or 1/Asynchronous. Async requires PostOperation.
nameNo
rankYes
stageYes10/PreValidation, 20/PreOperation, 40/PostOperation.
dryRunNoCompatibility alias for dry_run. Conflicting aliases are rejected.
dry_runNoRead-only preview of the environment, resolved target and changes. Configuration values are withheld. Default false.
messageYesExact SDK message name, for example Update.
pluginTypeNoCompatibility alias for plugin_type. Conflicting aliases are rejected.
descriptionNo
plugin_typeNo
primaryEntityNoCompatibility alias for primary_entity. Conflicting aliases are rejected.
conflictPolicyNoCompatibility alias for conflict_policy. Conflicting aliases are rejected.
primary_entityNoLogical table name. Omit for a global message registration.
conflict_policyNoDefault error. Multiple duplicates remain an error. update_existing preserves omitted optional fields/configuration.
environment_profileNoOptional named environment profile for this call; omit to use the configured default.
filteringAttributesNoCompatibility alias for filtering_attributes. Conflicting aliases are rejected.
impersonatingUserIdNoCompatibility alias for impersonating_user_id. Conflicting aliases are rejected.
secureConfigurationNoCompatibility alias for secure_configuration. Conflicting aliases are rejected.
supportedDeploymentNoCompatibility alias for supported_deployment. Conflicting aliases are rejected.
filtering_attributesNoEntity-specific Update only. Deduplicated, lowercased, checked against metadata; primary key rejected. Empty array clears filtering.
secure_configurationNoOptional secret; never echoed by a write or preview. Uses a new secure configuration row.
supported_deploymentNoDeployment: 0/ServerOnly, 1/OfflineOnly, 2/Both; availability depends on the target platform.
impersonating_user_idNoRun as this system user; null restores calling-user context.
unsecureConfigurationNoCompatibility alias for unsecure_configuration. Conflicting aliases are rejected.
allowUnprotectedUpdateNoCompatibility alias for allow_unprotected_update. Conflicting aliases are rejected.
unsecure_configurationNoOptional unsecure configuration; never echoed by a write or preview.
allow_unprotected_updateNoDefault false. Explicitly allow an update with If-Match:* if table metadata does not confirm optimistic concurrency. Does not bypass a supplied ETag conflict.

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/5.0
Behavior4/5

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

Annotations already flag destructive=true, idempotent=false, readOnly=false, and the description adds real substance on top: duplicate-signature detection, no automatic replay of writes, separate allocation of secure configuration bound during create, and that all phases report their IDs on failure. It does not cover required permissions or the success return shape, keeping it below a 5.

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?

Five dense sentences, front-loaded with the core action and followed by behavioral details; little filler. A few phrases such as "No write is automatically replayed" are terse to the point of ambiguity, but overall the structure is efficient.

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 destructive 27-parameter tool with no output schema, the description covers duplicate handling, secure configuration, failure reporting, and preview mode reasonably well. However, it never describes what a successful registration returns or what the agent should check afterwards, which is exactly the gap an absent output schema creates.

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?

With schema description coverage at 85% across 27 parameters, the schema already documents aliases, enums, and validation rules in detail. The description restates behavior for message/entity filters and filtering-field validation, adding only modest meaning beyond what the schema fields already say.

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 specific verb and resource ("Register a step for an existing native plugin type") and scopes it to existing native plugin types rather than new ones. This clearly separates it from siblings like d365_plugin_step_update and d365_plugin_steps_query without the agent needing to open a schema.

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?

Gives usable context: the plugin type must already exist, and dry_run provides a no-write preview. It stops short of naming alternatives (e.g., step_update for modifying an existing step) or stating when-not to call it, so it is clear context without explicit exclusions.

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