Skip to main content
Glama

validate_bpmn_diagram

Read-only

Check BPMN diagrams against bpmnlint rules to identify errors and warnings, returning structured issues with rule details and fix suggestions.

Instructions

Validate a BPMN diagram using bpmnlint rules. Returns structured issues with rule names, severities, element IDs, documentation URLs, and fix suggestions (concrete MCP tool calls to resolve each issue). Uses bpmnlint:recommended by default with tuning for AI-generated diagrams. Supports custom config overrides.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
configNoOptional bpmnlint config override. Default extends bpmnlint:recommended.
diagramIdYesThe diagram ID
lintMinSeverityNoMinimum lint severity that marks the diagram as invalid. 'error' (default) counts only errors. 'warning' counts warnings too.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
validYes
successYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.0

TDQS

A4.3/5.0
Behavior4/5

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

Annotations declare readOnlyHint=true, so safety profile is covered. The description adds significant behavioral detail: returns structured issues with rule names, severities, element IDs, documentation URLs, and fix suggestions as concrete MCP tool calls. This goes well beyond annotations, though it doesn't mention performance or determinism.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Three sentences, front-loaded with the core action and engine, followed by return value details and configuration options. No filler, every sentence adds value.

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?

Given the presence of an output schema, the description doesn't need to detail return values but still summarizes them helpfully. It covers default configuration, custom overrides, and validation severity behavior. An agent has everything needed to call and interpret the tool.

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

Parameters3/5

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

Schema coverage is 100% – all parameters (diagramId, config, lintMinSeverity) are fully described in the schema. The description mentions 'config overrides' and 'bpmnlint:recommended by default', which slightly reinforces the schema but adds no new syntax or format details. Baseline 3 is appropriate when schema does the heavy lifting.

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+resource ('Validate a BPMN diagram') and the engine used ('bpmnlint rules'). No sibling tool performs validation, so the purpose is unambiguous from the name and description.

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

Usage Guidelines4/5

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

Clear context: validating a BPMN diagram against bpmnlint rules. It mentions default config ('bpmnlint:recommended by default with tuning for AI-generated diagrams') and custom overrides, implying when to use defaults vs. custom. No explicit when-not-to-use or alternative, but the validation function is singular in the toolset.

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