bpmn-js-mcp

list_bpmn_elements

Read-only

List, filter, or inspect BPMN diagram elements by name pattern, type, property, or specific IDs to retrieve types, positions, connections, and properties.

Instructions

List elements in a BPMN diagram with their types, names, positions, connections, and properties. Supports optional filters to search by name pattern, element type, or property value. When no filters are given, returns all elements — unless the diagram is large, in which case an unfiltered call returns a type-count summary plus a bpmn://diagram/{id}/elements resource_link instead (pass inline: true to force the full list). Pass elementIds to inspect specific elements in full detail (all properties, extension elements, connections, event definitions) instead — ignores the other filters, one or several elements per call.

Input Schema

TableJSON Schema

Name	Required	Description
`inline`	No	Force the full element list even for a large, unfiltered diagram that would otherwise be summarized. Default: false.
`property`	No	Filter by a specific property key and optional value
`diagramId`	Yes	The diagram ID
`elementIds`	No	Inspect these specific elements in full detail instead of listing/filtering.
`elementType`	No	BPMN element type to filter by (e.g. 'bpmn:UserTask', 'bpmn:ExclusiveGateway')
`namePattern`	No	Regular expression pattern to match against element names (case-insensitive). Only matching elements are returned.

Output Schema

TableJSON Schema

Name	Required	Description	Default
`count`	No
`success`	Yes

Schema Changelog

Changes observed during successful MCP inspections.

First observedv1.0.0Oct 6, 2026

TDQS

A4.8/5.0

Behavior5/5

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

Annotations already declare readOnlyHint=true and openWorldHint=false, but the description goes well beyond by disclosing the large-diagram summarization behavior, the returned bpmn:// resource_link, the inline override, and the detail-expansion semantics of elementIds. These are non-obvious behaviors an agent must know before calling.

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?

Front-loaded with the primary behavior, then filters, then the large-diagram caveat, then the elementIds alternative. Dense and mostly waste-free, though the final sentence about elementIds packs several clauses that could be split for readability.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

With an output schema present, return-value detail is not required, and the description still covers the important non-obvious return behavior (summary vs full list plus resource_link). For a 6-param tool with nested objects, this is complete.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, so baseline is 3, but the description adds real meaning: inline forces the full list on large unfiltered diagrams, and elementIds switches to a full-detail inspection mode that ignores the other filters. It slightly under-explains how the filters combine, but the added semantics are genuine.

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 (List) and resource (BPMN diagram elements) plus what is returned: types, names, positions, connections, properties. It is clearly distinguishable from siblings like add_bpmn_elements, delete_bpmn_element, and set_bpmn_element_properties.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Explicitly covers when to filter (by name pattern, type, property value), what happens without filters (all elements vs type-count summary for large diagrams), how to override that (inline: true), and when to use the elementIds mode instead, noting it ignores other filters. Alternatives and conditions are fully spelled out.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.