Skip to main content
Glama

Front-End Checklist

Explain Frontend Rule

explain_rule
Read-onlyIdempotent

Retrieves the educational explanation for a frontend rule. Use PROACTIVELY when the user asks "why" about frontend practices, or when explaining code review feedback. Provides context on why the rule matters, its background, and impact on web development. Categories help connect related concepts.

Workflow: Use when users question a recommendation, or after fix_rule to provide educational context. Pair with check_rule to validate understanding, or search_rules to find related best practices in the same category.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
slugYesThe rule's slug

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
slugNo
titleNo
messageNo
categoriesNo
suggestionsNo
explainPromptNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.9/5.0
Behavior3/5

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

Annotations already declare readOnlyHint, idempotentHint, and non-destructive behavior, and an output schema exists, so the safety and return profile is covered elsewhere. The description only adds that explanations include background/impact and that categories connect related concepts — useful but modest added context.

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?

Front-loaded with the core purpose in the first sentence, then structured under a bolded Workflow. Slightly dense with bolded emphasis and multiple sibling references, but every clause carries routing or scope information.

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 rich annotation set, a fully documented single parameter, and an output schema, the description need not explain returns. It supplies the missing piece — when to invoke it and which siblings to pair it with — though it could clarify how it differs from get_rule.

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?

One required parameter (slug) with 100% schema description coverage, so the schema does the work. The description adds no format or sourcing detail for the slug beyond what the schema states; 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: retrieves the educational explanation for a frontend rule, and adds scope (why the rule matters, background, impact). It does not explicitly contrast itself with the close sibling get_rule, so an agent must infer the difference between the 'rule' and its 'explanation'.

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?

Explicit triggers ('when the user asks "why"', 'when explaining code review feedback') and a named workflow: use after fix_rule for educational context, pair with check_rule to validate understanding, search_rules to find related practices. The when-to-use and alternatives are both named.

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.