Skip to main content
Glama

Explain Frontend Rule

explain_rule
Read-onlyIdempotent

Explains one frontend rule, including its background, impact on users and the business, and related categories. Use it when the user asks why a practice matters or requests educational context. It returns explanation guidance rather than applying a fix.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
slugYesRule slug: the kebab-case rule ID, e.g. 'alt-text' or 'doctype'. The ID must identify a rule in the published catalogue.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
slugNo
titleNo
messageNo
categoriesNo
suggestionsNo
explainPromptNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • changedInput schema / properties / slug / description
      Previous value: -"The rule's slug"New value: +"Rule slug: the kebab-case rule ID, e.g. 'alt-text' or 'doctype'. The ID must identify a rule in the published catalogue."
  2. First observed

TDQS

A4/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true, idempotentHint=true, and destructiveHint=false, so the safety profile is covered. The description adds value by clarifying that the tool returns explanation guidance rather than applying a fix, which tells the agent the output is advisory content, not a mutation or a remediation action.

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?

Three short sentences, front-loaded with the core action, then usage, then output nature. Every sentence earns its place with no repetition of the name or title.

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?

With a full output schema present, the description does not need to explain return values, and annotations cover safety. It is complete for the core call, but the unresolved overlap with the get_rule sibling leaves a small ambiguity an agent must resolve elsewhere.

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?

Only one parameter exists and schema description coverage is 100%, so the schema already documents the slug format and the catalogue constraint. The description adds nothing about the slug, which is the expected baseline when the schema does the work.

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?

The description gives a specific verb and resource ('Explains one frontend rule') and enumerates the content it covers (background, user/business impact, related categories). It distinguishes itself from fix_rule by stating it returns explanation guidance rather than applying a fix, but it never clarifies how it differs from the sibling get_rule, which an agent can only infer.

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?

It states a clear trigger condition: 'Use it when the user asks why a practice matters or requests educational context.' That is explicit when-to-use guidance. There is no when-not guidance beyond the implicit contrast with fix_rule, so it falls short of naming alternatives outright.

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.