Skip to main content
Glama
LGDiMaggio

Predictive Maintenance MCP Server

by LGDiMaggio

generate_diagnostic_report_docx

Generate a structured Word diagnostic report from vibration analysis results. Include statistics, FFT peaks, bearing frequencies, and ISO evaluations for machinery fault detection.

Instructions

    Generate a structured Word (.docx) diagnostic report.

    Requires: ``pip install predictive-maintenance-mcp[docx]``

    ``sections`` is a dict whose keys define what to include (all optional):
      - statistics:           dict  (RMS, Kurtosis, Crest Factor …)
      - fft_peaks:            list  [{frequency, magnitude_db, note}, …]
      - envelope_peaks:       list  [{frequency, magnitude_db, match}, …]
      - bearing_frequencies:  dict  {BPFO, BPFI, BSF, FTF}
      - iso:                  dict  (from evaluate_iso_20816 output)
      - diagnosis:            str   (free-text diagnostic summary)

    Args:
        signal_file: Signal filename used for the report title / filename
        sections: Content sections to include (see above)
        title: Optional custom report title
        ctx: MCP context

    Returns:
        Dictionary with file_path, file_name, and per-section summary.
    

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
signal_fileYes
sectionsYes
titleNo

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Behavior4/5

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

No annotations are provided, so the description carries the full burden. It discloses the installation requirement (pip install), the optional nature of sections, and the expected return structure. It does not mention potential side effects (e.g., file overwriting) or permissions, but overall provides sufficient behavioral context for safe operation.

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?

The description is well-structured with clear sections for purpose, installation, parameter details, and return value. It is slightly long due to the detailed sections dictionary, but each sentence adds value and the bullet-point format aids readability.

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

Completeness4/5

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

Given the tool has an output schema (mentioned in context) and 3 parameters with nested objects, the description provides sufficient context: it explains the nested structure, optionality, and return values. No major gaps are apparent, though it could note what happens with empty sections.

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

Parameters5/5

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

With 0% schema description coverage, the description adds essential meaning. It thoroughly explains the 'sections' parameter with a detailed dictionary of optional keys and their types, and clarifies that 'signal_file' is used for the report title/filename. This compensates well for the sparse schema.

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?

The description explicitly states 'Generate a structured Word (.docx) diagnostic report' and details the included sections (statistics, FFT, envelope, bearing frequencies, ISO, diagnosis). This clearly distinguishes it from sibling tools that generate reports for specific analyses (e.g., generate_fft_report, generate_envelope_report).

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?

The description implies use for creating a comprehensive diagnostic report by listing the sections, but does not explicitly state when to use this tool versus the more specific report generators (e.g., generate_fft_report). No direct guidance on alternatives or exclusions is provided.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/LGDiMaggio/predictive-maintenance-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server