Guide / Every rule
Tool of an AI agent without documentation
The check compat/agent-tool-documentation, in the group Engine compatibility.
Why it matters
The agent picks its tools by their documentation, so a tool with none is hard to choose and easy to misuse.
How to fix it
Describe what the tool does in its documentation.
Where you see it
The Problems tab lists it under Engine, the editor marks the element on the canvas, and penstock check reports it as compat/agent-tool-documentation. It checks the diagram against the engine and the version it is written for: the version in the file's modeler:executionPlatformVersion, or the newest one when the file has none. Operaton and CIB seven are checked as Camunda 7. This check is free.
To turn it off, set camunda-compat/agent-tool-documentation or compat/agent-tool-documentation to off in your .bpmnlintrc. See Validation.
Rule details
| Id | compat/agent-tool-documentation |
| Group | Engine compatibility |
| Level | Advice: it works, and reads or runs better without it |
Read more: Validation. All rules: Every rule.