Edit

Remove synonyms

Applies to: Dynamics 365 Customer Service

Note

  • The tools and examples in this documentation illustrate current capabilities. Tool names, descriptions, parameters, response formats, and available functionality can change over time.
  • When you build agents, integrations, or orchestration logic, don't hard-code dependencies on specific tool names, parameter structures, tool metadata, or response schemas. Instead, design your solution to discover and use available tools at runtime.
  • As the platform evolves, Microsoft might add, remove, rename, or modify tools and tool metadata. Designing against capabilities rather than specific tool identifiers helps maintain compatibility across service updates.

Use this capability to delete column synonyms you no longer want the Customer Service question-answering skill to use.

What it does

Deletes one or more column synonyms. Out-of-the-box managed synonyms can't be removed and are skipped.

Try prompts like

  • Delete this synonym.
  • Remove the synonyms for the owner column.

What you'll see in chat

This action is normally used from the Manage Customer Service vocabulary editor. After a delete, the editor refreshes and the assistant reports how many synonyms were removed.

Helpful tips

  • Select the synonyms in the editor and confirm the delete.
  • Managed (out-of-the-box) synonyms are skipped and reported as not removed.
  • Deleting a synonym can't be undone.

What happens next

The assistant stops using the removed synonyms. Continue managing vocabulary from the editor.

Does this change data?

Yes. Removing synonyms deletes configuration records in Dataverse.

Prerequisites

This tool is available on the Dynamics 365 Customer Service MCP server. It requires the maker customize privilege (prvmsdyn_ServiceAgentMakerCustomize) and a provisioned CustomerServiceQnA skill.

Tool summary

Property Value
User-facing name Remove synonyms
Internal tool name remove_synonyms
Purpose Deletes one or more column synonyms from the CustomerServiceQnA skill

Tool behavior

Deletes the copilotsynonyms rows for the supplied ids, protecting out-of-the-box managed rows (reported as not removed). Typically invoked by the Manage Customer Service vocabulary editor.

Annotations

Annotation Value Meaning
readOnlyHint false Deletes configuration data.
destructiveHint true Permanently deletes the selected synonyms.
idempotentHint false Deleting an already-deleted synonym reports it as not found.
openWorldHint Not set Uses default (writes to Dataverse).

Input concepts

Synonyms to remove

Input Description Required
ids One or more copilotsynonymsid values to delete (up to 25). Yes

Response and UI behavior

This tool returns a text result with a per-id outcome (deleted, managed-protected, or not found). It doesn't render its own app-in-chat component; it's used by the Manage Customer Service vocabulary editor.

Response type

Text (per-id outcomes)

Routing notes

Use remove_synonyms to delete synonyms. To add or edit synonyms use save_synonym.

Tool Relationship
manage_service_vocabulary Opens the editor these deletes come from
save_synonym Adds or updates a synonym

Data mutation classification

Destructive write.

Permanently deletes synonym configuration records. Managed rows are protected.