Skip to main content
Glama

Suede QA Checklist

suede_qa_checklist
Read-onlyIdempotent

Generate a multi-lane QA checklist for Suede skills, local plugin notes, MCP servers, docs, or public pages, tailored by scope and target.

Instructions

Generate a multi-lane QA checklist for Suede skills, local plugin notes, MCP servers, docs, or public pages.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "suede_qa_checklist"
  }
}

Input Schema

NameRequiredDescriptionDefault
scopeNoQA depth, such as fast, full, release, seo, or mcp.
targetNoTarget repo, URL, skill, MCP server, page, or change.

Output Schema

NameRequiredDescriptionDefault
scopeYes
targetYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

C2.9/5.0
Behavior2/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 safety is covered. The description adds no behavioral context: it never explains what a 'lane' is, how many are produced, whether 'scope' presets change the output, or that the result is a new artifact rather than an assessment of the target. The jargon 'multi-lane' carries no disclosed meaning.

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 or repetition. It is appropriately sized, though the undefined 'multi-lane' term consumes words without conveying information.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

With only two optional parameters, full schema coverage, annotations, and an output schema, the definition is minimally sufficient. It nevertheless omits what a generated checklist looks like in kind and why one would choose this over the sibling audit and grade tools, which matters in a suite this dense.

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%, so the baseline is 3. The description echoes the target taxonomy that the 'target' parameter already documents and says nothing at all about 'scope' presets (fast, full, release, seo, mcp), adding no meaning beyond the schema.

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 ('Generate') and resource ('multi-lane QA checklist') plus an enumerated set of targets (skills, plugin notes, MCP servers, docs, public pages). 'Multi-lane' is unexplained jargon, and no sibling such as suede_code_grade or suede_live_page_audit is named to sharpen the boundary, so it is clear but not fully differentiated.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The list of target types hints at applicability, but there is no explicit when-to-use statement, no prerequisites, and no pointer to alternatives among the many audit/grade siblings (suede_code_grade, suede_visibility_grade, suede_copy_check). An agent must infer whether it should call this or an audit tool.

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