Skip to main content
Glama

Front-End Checklist

Get Quick Reference

get_quick_reference
Read-onlyIdempotent

Returns a compact, actionable checklist of rules for a category. Use PROACTIVELY for CI/CD integration, quick audits, or generating checklists. Supports filtering by priority and multiple output formats.

Workflow: Use for generating quick checklists before deployment or for team handoffs. Pair with check_rule to validate specific items, or get_rule for detailed guidance on any item.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
formatNoOutput format (default: 'json'). Use 'markdown' for readable docs, 'checklist' for copy-paste task lists.
categoryYesThe category to get a quick reference for (e.g., 'accessibility', 'performance', 'seo')
priorityFilterNoFilter by priority level (default: 'critical+high'). Use 'all' for comprehensive lists, 'critical' for essentials only.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
errorNo
itemsNo
categoryNo
markdownNo
totalCountNo
displayNameNo
priorityFilterNo

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, non-destructive and closed-world, so the safety profile is fully covered by structured data. The description adds the compact/checklist nature of the output but nothing about size limits, rate limits, or whether categories are fixed. Adequate but not rich on top of 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?

Front-loaded with the core purpose and tightly organized into a purpose sentence and a workflow line. The bold '**Use PROACTIVELY**' and workflow pairing are useful, not padding, though the second paragraph slightly restates the first.

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?

An output schema exists so return values need no explanation, and annotations cover the safety profile. The description supplies the usage context and sibling routing an agent needs; only minor behavioral details (e.g., category source, typical list size) are absent.

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?

Schema description coverage is 100% with enum values documented for both format and priorityFilter, so the schema carries the parameter semantics. The description only echoes 'filtering by priority and multiple output formats' without adding syntax or defaults beyond the schema.

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 and resource ('Returns a compact, actionable checklist of rules for a category') and explicitly contrasts itself with siblings by naming check_rule for validation and get_rule for detailed guidance. An agent can tell it apart from get_rule and get_checklist_rules without opening schemas.

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?

Usage is well specified: '**Use PROACTIVELY** for CI/CD integration, quick audits, or generating checklists' plus the workflow note about pre-deployment and team handoffs. Alternatives are named (check_rule, get_rule), though no explicit 'when-not-to-use' condition is given.

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.