Skip to main content
Glama

Wardzo

Explain an issue and how to fix it

explain_issue
Read-only

Explain why an issue matters and give step-by-step fix instructions (with Next.js, Vercel, Netlify, Nginx, Apache, Cloudflare and WordPress snippets where relevant) that an AI coding agent can apply, plus how to verify.

Input Schema

NameRequiredDescriptionDefault
issue_idYesissue_id from list_issues/scan_site (e.g. "AbC123xyz:hsts_missing") or a check name (e.g. "exposed_env")

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.7/5.0
Behavior4/5

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

The readOnlyHint annotation already establishes the safety profile, and the description adds genuinely useful behavioral context by disclosing the shape of the output: remediation steps with framework-specific snippets (Next.js, Vercel, Nginx, etc.) and verification guidance. It doesn't cover rate limits or output format details, but for a read-only explainer this is solid added value.

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 no filler; the parenthetical framework list is dense but earns its place by telling the agent what kind of remediation content to expect. Slightly run-on but efficient.

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?

There is no output schema, so the description carries the burden of describing returns, and it does so adequately (explanation, fix steps, snippets, verification). Combined with readOnlyHint covering safety, an agent has enough to call this correctly.

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

Parameters3/5

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

With a single parameter at 100% schema description coverage, the schema already documents issue_id, its length constraints, both accepted formats, and examples. The description adds nothing about the parameter, so the baseline 3 applies.

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?

States a specific verb and resource ('explain an issue') and enumerates the output content: why it matters, step-by-step fix instructions, and verification steps. It is clearly distinct in kind from siblings like list_issues/scan_site, though it doesn't explicitly name them as alternatives.

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 only implied: the schema's issue_id description points at list_issues/scan_site as the source of the ID, so the workflow (list/scan, then explain) is inferable. There is no explicit statement of when to choose this over recheck_site or get_report, and no exclusions.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources