Skip to main content
Glama

Get Node-RED diagnostics

nodered_get_diagnostics
Read-onlyIdempotent

Read Node-RED's diagnostics report for Node.js, OS, memory, runtime state, and module versions to troubleshoot slow or stopped flows and collect version details for bug reports.

Instructions

Read Node-RED's own diagnostics report: Node.js, OS, memory, runtime state and module versions.

Calls GET /diagnostics (the report behind the editor's Help → diagnostics), which already reduces sensitive settings to a set/unset marker; any remaining secret-looking field is replaced by the placeholder. Changes nothing.

Use when: Node-RED is slow, flows are stopped, or a bug report needs versions. Not for: the add-on log — use supervisor_get_addon_logs; installed palette modules in a compact form — use nodered_get_info. Returns: {"addon_slug", "report": {...}} as Node-RED sends it. Errors: HTTP <status> when diagnostics are disabled in settings.js, plus the add-on lookup errors of nodered_list_flows.

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": "nodered_get_diagnostics"
  }
}

Input Schema

NameRequiredDescriptionDefault

No arguments

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv0.29.0

TDQS

A4.9/5.0
Behavior5/5

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

Annotations already declare read-only, idempotent, non-destructive and closed-world, but the description adds genuinely non-obvious behavior: sensitive settings are reduced to set/unset markers, residual secret-looking fields are replaced with a placeholder, and the call changes nothing. It also names the failure mode (HTTP status when diagnostics are disabled in settings.js) and the add-on lookup errors inherited from nodered_list_flows.

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?

Front-loaded with the one-line purpose, then segmented into Use when / Not for / Returns / Errors. Every sentence carries operational information — routing, redaction, shape, or failure — with no filler or repetition.

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?

For a zero-argument read tool this covers everything an agent needs: what is returned, that redaction is already applied, that nothing is mutated, and how errors surface. Although an output schema exists, restating the top-level `{addon_slug, report}` shape is cheap and confirms the nested payload comes through as Node-RED sends it.

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 no parameters, which is the baseline case for a 4. The description could have said explicitly that no arguments are accepted or configurable, but with an empty schema that constraint is already unambiguous.

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?

Uses a specific verb and resource — 'Read Node-RED's own diagnostics report' — and enumerates the contents (Node.js, OS, memory, runtime state, module versions), which cleanly separates it from nodered_get_info and the add-on log. The underlying endpoint is named, so the agent knows exactly what is fetched.

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?

Contains explicit 'Use when' triggers (slow runtime, stopped flows, bug report needing versions) and an explicit 'Not for' clause that routes to supervisor_get_addon_logs and nodered_get_info by name. Both the positive and negative conditions are stated rather than inferred.

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

Deploy Server

Other Tools