Skip to main content
Glama

generer_documentation

Read-onlyIdempotent

Generates a Markdown reference documenting every PLC variable's type, unit, range, permissions, live value, and description, plus the write policy.

Instructions

Parcourt l'automate et génère la fiche Markdown de toutes ses variables (type, unité, plage, droits, valeur actuelle, description), ainsi que la politique d'écriture.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "generer_documentation"
  }
}

Input Schema

NameRequiredDescriptionDefault

No arguments

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A3.7/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, idempotentHint=true and openWorldHint=false, so the safety profile is covered. The description adds useful behavioral content beyond that by describing the traversal of the entire automaton and the fields collected (including current value and write policy). It does not say where the Markdown goes, whether a file is written to disk, or how large automata affect the operation, but with an output schema present the remaining gaps are moderate.

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?

A single front-loaded sentence with the verb first, followed by the parenthetical field list, which is dense but each element carries information about the generated artifacts. The parenthetical is longer than strictly necessary but does real work in setting output expectations.

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 no inputs, three covering annotations and an output schema in place, the description supplies everything needed to select and call the tool: what it reads, what it emits, and the scope (all variables plus write policy). No important decision-relevant element is missing for a tool of this simplicity.

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?

The tool takes zero parameters, so there is no parameter meaning for the description to add; the baseline for 0-param tools applies. Nothing in the description misleads about inputs.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

Specific verb plus resource: "Parcourt l'automate et génère la fiche Markdown de toutes ses variables", with an explicit enumeration of the emitted fields (type, unité, plage, droits, valeur actuelle, description) plus the write policy. That scope is plainly distinct from read/list siblings such as lister_variables or lire_variable, though no sibling is named.

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

Usage Guidelines3/5

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

Usage is strongly implied: the tool exists to produce documentation over the whole automaton, so an agent can infer it is the documentation-generation step. However, there is no explicit when/when-not, no statement that it is read-only documentation versus something needed before writing, and no named alternative.

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