mcp_get_custom_apis

Summary

Field	Value
Tool name	get_custom_apis
MCP title	List custom API definitions
Category	standard
Implementation	DynamicsCrm.DevKit.Cli/Mcp/Tools/GetCustomApisTool.cs
Estimated token count	~254 tokens (tools/list tool JSON, o200k_base, measured 2026-06-18)
Last verified	2026-06-18

MCP Tool Description (Exact)

Custom API definitions — modern replacement for Custom Actions (binding, visibility, plugin attachment, typed params). api_name empty = list (filter by entity_name, status, include_microsoft). Set = detail (request params, response properties, plugin binding). Managed APIs excluded by default. isFunction=true → GET (no side effects); false → POST Action.

WHEN TO USE:
- Discover Custom APIs registered on an entity (or globally)
- Inspect input/output params + plugin binding before invoking
- For legacy Custom Actions (workflow-based) use get_messages

Parameters

Name	Type	Required	Default	Description
api_name	string	No	""	Display Name or unique name → detail. Empty = list.
entity_name	string	No	""	Bound entity Display Name or logical name. Empty = all.
include_microsoft	boolean	No	false	Include managed APIs.
status	string	No	"active"	'active' / 'inactive' / 'all'.
max_records	integer	No	100	1–500.

Input Schema

{
  "type": "object",
  "properties": {
    "api_name": {
      "type": "string",
      "description": "Display Name or unique name → detail. Empty = list.",
      "default": ""
    },
    "entity_name": {
      "type": "string",
      "description": "Bound entity Display Name or logical name. Empty = all.",
      "default": ""
    },
    "include_microsoft": {
      "type": "boolean",
      "description": "Include managed APIs.",
      "default": false
    },
    "status": {
      "type": "string",
      "description": "'active' / 'inactive' / 'all'.",
      "default": "active"
    },
    "max_records": {
      "type": "integer",
      "description": "1–500.",
      "default": 100
    }
  },
  "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

• Discover Custom APIs registered on an entity (or globally)
• Inspect input/output params + plugin binding before invoking
• For legacy Custom Actions (workflow-based) use get_messages

Notes

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

Example

{
  "api_name": "string"
}

Output

Returns CallToolResult from the MCP server. The response content and structured fields follow the tool implementation and model returned by GetCustomApisTool.get_custom_apis.

Prompt Examples

• "List unmanaged Custom APIs bound to Account and show their request parameters."
• "Inspect this Custom API and tell me whether it is a function or action."
• "Find active global Custom APIs and include plugin binding information."