Skip to main content
Glama
byreshb

testing-toolkit-mcp

by byreshb

List test-quality-linter rules

tql.rules
Read-onlyIdempotent

Lists all test quality lint rules with their IDs, names, default severities, and one-line descriptions. Use it to see which checks apply and find rule details for further documentation.

Instructions

Returns the catalogue of rules the linter applies: id, name, default severity and a one-line description. Use tql.explain or the toolkit://tql/rules/{id} resource for the full documentation of one rule.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
rulesYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.1.1-SNAPSHOT

TDQS

A4.5/5.0
Behavior3/5

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

Annotations already establish readOnlyHint=true and idempotentHint=true, so no side-effect warning is needed. The description adds the content shape of the returned catalogue, but since an output schema exists, this is somewhat redundant; no additional operational caveats such as pagination or rate limits are disclosed.

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?

Two tight sentences: the first states what the tool returns, and the second routes to the alternative for deeper detail. There is no filler or repetition of structured fields.

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

Completeness5/5

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

For a parameterless, read-only, idempotent list tool with an output schema, the description covers the purpose and the obvious follow-up action. Nothing needed for correct invocation is missing.

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

Parameters4/5

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

The tool has zero parameters, so there is no parameter semantics burden on the description. The baseline of 4 applies because no parameter documentation is needed.

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 clearly states a specific action ('Returns the catalogue of rules'), identifies the resource (rules the linter applies), and lists the included fields. It also distinguishes itself from tql.explain by noting that the sibling is for full documentation of a single rule, so an agent can select the right tool 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 Guidelines5/5

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

It explicitly tells the agent to use tql.explain or the toolkit://tql/rules/{id} resource when full documentation of one rule is needed, which implies this tool is for the complete catalogue. This is a clear alternative-routing statement, leaving little to inference.

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