Skip to main content
Glama
dave1362

RCA-MCP Connector

rca_guide_generate_report

Read-onlyIdempotent

Turn resolved diagnostic sessions into structured maintenance reports with root cause, confidence score, recommended actions, parts list, measurements, guide references, and escalation flag.

Instructions

🌟 Starter+ (markdown) / šŸ’Ž Pro+ (PDF/HTML) — Generate a maintenance/ troubleshooting report from a completed diagnostic session. The session must already be resolved (finished via rca_dtree_answer) — an in-progress session returns an error telling you to keep answering questions first.

Report includes equipment/symptom summary, full diagnostic path, root cause with confidence score, recommended actions and parts list, measurements recorded, guide section references, and escalation flag.

Args: params (GuideReportInput): - session_id: must be a session already marked "resolved" (check via rca_dtree_list_sessions) - format: "markdown" (default, Starter+), "pdf" or "html" (Pro+ only — Starter requesting these gets plan_required, not a silent downgrade) - include_guide_refs, custom_title

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
paramsYes

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changedv4.1.15
    • addedInput schema / $defs / GuideReportInput / properties / client_id / description
      Added value: +"Client namespace ID"
    • addedInput schema / $defs / GuideReportInput / properties / token / description
      Added value: +"API key to authenticate this request"
  2. Changed3 schema fields changedv4.1.14
    • addedInput schema / $defs / GuideReportInput / properties / custom_title / description
      Added value: +"Custom report title, up to 200 chars (default: auto-generated from equipment/symptom)"
    • addedInput schema / $defs / GuideReportInput / properties / format / description
      Added value: +"'markdown' (default, Starter+) or 'pdf'/'html' (Pro+ only — Starter requesting these gets plan_required, not a silent downgrade)"
    • changedInput schema / $defs / GuideReportInput / properties / session_id / description
      Previous value: -"Completed diagnostic session ID"New value: +"A session_id already marked 'resolved' (check via rca_dtree_list_sessions)"
  3. First observedv4.1.13

TDQS

A4.3/5.0
Behavior4/5

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

Annotations already mark this as read-only, idempotent, and non-destructive, and the description adds useful behavior beyond them: it returns plan_required for Starter users requesting Pro formats, it errors on unresolved sessions, and it lists the report's contents. No contradiction exists between the description and annotations.

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 organized with a clear purpose statement, prerequisite warning, report-content summary, and arg bullets. It is somewhat long and repeats the 'resolved session' requirement twice, but the structure is readable and front-loaded with the most important call condition.

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?

The tool has an output schema, so return-value details are not required here. The description adequately covers prerequisites, failure behavior, plan gating, and parameter semantics, making it complete enough for an agent to call correctly. It could have addressed sibling alternatives like rca_report_generate, but that is a minor gap.

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?

Despite the reported 0% schema-description coverage, the description adds significant parameter context: session_id must be resolved, format has plan-level restrictions, and include_guide_refs/custom_title are explained. It omits token and client_id in the prose arg list, but the input schema supplies descriptions for those, so the overall parameter guidance is strong.

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 states a specific verb ('generate') and a specific resource ('maintenance/troubleshooting report from a completed diagnostic session'), and it clearly connects the tool to the diagnostic workflow. It also distinguishes this tool from siblings like rca_report_generate by requiring a completed diagnostic session via rca_dtree_answer.

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?

The description gives explicit conditions: the session must already be resolved, in-progress sessions will error, and the user should check rca_dtree_list_sessions. It also explains when the PDF/HTML formats are allowed based on plan level. It does not explicitly name alternative tools, but it provides clear prerequisite and error guidance.

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