Skip to main content
Glama

a11y-toolkit: Honest SVG badge

a11y_badge
Read-onlyIdempotent

Generate an accessible SVG badge displaying audit score, date, and scope. Use it to show honest accessibility status on audited sites without claiming WCAG conformance.

Instructions

Returns an HONEST accessibility badge as accessible SVG: score, date and scope (automated screening ≈ 1/3 of WCAG), color-coded by score. Deliberately does NOT say "conformant" — the honest seal. Embed it in audited sites or statements. — Scope: the honest SVG seal for audited sites; the machine-readable bundle is a11y_evidence.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
langNoBadge language (default en)
fechaNoISO date (today by default)
scoreYes0-100 (from an audit result)

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv4.0.0
    • addedInput schema / properties / lang / description
      Added value: +"Badge language (default en)"
  2. Addedv3.3.0

TDQS

A4.4/5.0
Behavior4/5

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

Annotations already declare readOnlyHint, idempotentHint, and destructiveHint, covering the safety profile. The description adds important behavioral context: the badge is deliberately non-conformant, is based on automated screening covering roughly one-third of WCAG, and is color-coded by score.

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?

The description is front-loaded with the core purpose and kept short. The word 'honest' is repeated a few times and the scope note could be tightened, but every sentence contributes useful information.

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?

Despite having no output schema, the description explains the return value's format, content, and purpose, while annotations cover side-effect safety. An agent can confidently call this tool for badge generation without missing critical information.

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 schema already documents score, fecha, and lang with descriptions and an enum. The description only confirms that score and date appear in the badge, adding little 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 clearly defines the tool as returning an accessibility badge as accessible SVG with score, date, scope, and color-coding, and explicitly states that it does NOT claim WCAG conformance. It also distinguishes itself from a11y_evidence by scope, so an agent can tell it apart from siblings.

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 gives explicit embed contexts ('audited sites or statements') and a scope note that directs machine-readable-bundle needs to a11y_evidence. This provides a clear when-to-use and when-not-to-use distinction among siblings.

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