mcp_get_messages

Summary

Field	Value
Tool name	get_messages
MCP title	List SDK messages and custom actions
Category	standard
Implementation	DynamicsCrm.DevKit.Cli/Mcp/Tools/GetMessagesTool.cs
Estimated token count	~228 tokens (tools/list tool JSON, o200k_base, measured 2026-06-18)
Last verified	2026-06-18

MCP Tool Description (Exact)

SDK messages + Custom Actions for an entity (or global with entity_name='none'). message_name empty = list. Set = detail (params, supported entities, plugin steps). Covers legacy Custom Actions (workflow-based, category=3); for modern Custom APIs use get_custom_apis.

WHEN TO USE:
- Find SDK messages available for plugin registration
- Discover Custom Actions on an entity
- Inspect input/output parameters of a legacy Custom Action

Parameters

Name	Type	Required	Default	Description
entity_name	string	No	"none"	Entity Display Name or logical name. 'none'/empty = global messages (WhoAmI, etc.). Ignored in detail mode (when message_name is set).
message_name	string	No	""	Message/Action name → detail mode. Empty = list mode.
include_custom_actions	boolean	No	true	List: include Custom Actions. false = SDK messages only. Ignored in detail mode.

Input Schema

{
  "type": "object",
  "properties": {
    "entity_name": {
      "type": "string",
      "description": "Entity Display Name or logical name. 'none'/empty = global messages (WhoAmI, etc.). Ignored in detail mode (when message_name is set).",
      "default": "none"
    },
    "message_name": {
      "type": "string",
      "description": "Message/Action name → detail mode. Empty = list mode.",
      "default": ""
    },
    "include_custom_actions": {
      "type": "boolean",
      "description": "List: include Custom Actions. false = SDK messages only. Ignored in detail mode.",
      "default": true
    }
  },
  "required": []
}

Related MCP Resources

Resource	URI / URI template	MIME type	Reason
server_logic_guide	docs://server_logic_guide	text/markdown	Inferred from source: Filtering patterns, list/detail modes, and entity scoping for server-logic tools. Read this when get_plugins, get_workflows, get_flows, etc. returns an error.

When To Use

• Find SDK messages available for plugin registration
• Discover Custom Actions on an entity
• Inspect input/output parameters of a legacy Custom Action

Notes

• Use the exact MCP description and parameter schema above as the authoritative contract.

Example

{
  "entity_name": "string"
}

Output

Returns Task<CallToolResult> from the MCP server. The response content and structured fields follow the tool implementation and model returned by GetMessagesTool.get_messages.

Prompt Examples

• "List SDK messages available for plugins on the Account table."
• "Show details for this legacy Custom Action, including input and output parameters."
• "Find global custom actions and identify which plugin steps are registered."