mcp_get_business_process_flows

Summary

Field	Value
Tool name	get_business_process_flows
MCP title	List business process flows and stages
Category	standard
Implementation	DynamicsCrm.DevKit.Cli/Mcp/Tools/GetBusinessProcessFlowsTool.cs
Estimated token count	~319 tokens (tools/list tool JSON, o200k_base, measured 2026-06-18)
Last verified	2026-06-18

MCP Tool Description (Exact)

Business Process Flows (BPFs) + stages. Each BPF auto-creates its own Dataverse entity (uniqueName = logical name). bpf_id empty = list. Set = detail with stages. BPFs can span multiple entities (Lead → Opportunity); each stage has its own primaryEntity.

WHEN TO USE:
- Inspect stage sequence + primary entities for a BPF
- Find BPFs bound to an entity (entity_name filter)
- Resolve BPF unique/logical name for the auto-created entity

Fuzzy on bpf_name: 0/multi → tool returns disambiguation list and stops; AI must ask user. 1 → auto-detail.

Parameters

Name	Type	Required	Default	Description
bpf_id	string	No	""	GUID → detail. Empty = list.
bpf_name	string	No	""	Name contains. 1 match → auto-detail.
entity_name	string	No	""	Primary entity filter, Display Name or logical name (e.g. 'Lead' or 'lead').
status	string	No	"active"	'active' / 'draft' / 'all'.
include_stages	boolean	No	false	List only. Detail always includes.
max_records	integer	No	50	1–250.

Input Schema

{
  "type": "object",
  "properties": {
    "bpf_id": {
      "type": "string",
      "description": "GUID → detail. Empty = list.",
      "default": ""
    },
    "bpf_name": {
      "type": "string",
      "description": "Name contains. 1 match → auto-detail.",
      "default": ""
    },
    "entity_name": {
      "type": "string",
      "description": "Primary entity filter, Display Name or logical name (e.g. 'Lead' or 'lead').",
      "default": ""
    },
    "status": {
      "type": "string",
      "description": "'active' / 'draft' / 'all'.",
      "default": "active"
    },
    "include_stages": {
      "type": "boolean",
      "description": "List only. Detail always includes.",
      "default": false
    },
    "max_records": {
      "type": "integer",
      "description": "1–250.",
      "default": 50
    }
  },
  "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

• Inspect stage sequence + primary entities for a BPF
• Find BPFs bound to an entity (entity_name filter)
• Resolve BPF unique/logical name for the auto-created entity

Notes

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

Example

{
  "bpf_id": "string"
}

Output

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

Prompt Examples

• "List active business process flows for Opportunity and include their stages."
• "Find the BPF named Sales Process and show each stage primary entity."
• "Identify the Dataverse entity name created for this business process flow."