Skip to main content
Glama

agent-readiness

Get the badge embed

get_badge_embed
Read-only

Get the HTML snippet for a site's Agent Readiness badge, so it can be placed on that site. Sites at grade C or better earn bronze, silver or gold. Use when the user has a passing score and wants to display it. Returns HTML to paste; it installs nothing and runs no script.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
urlYesPublic http(s) address, for example example.com

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
hostYes
htmlNo
noteNo
tierNo
gradeYes
scoreYes
reasonNo
watchItNo
eligibleYes
fixFirstNo
badgePageNo
reportUrlNo

Schema Changelog

Changes observed during successful MCP inspections. Dates show when Glama detected each change.

  1. First observed

TDQS

A4.3/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true, and the description adds meaningful behavioral context beyond that: 'it installs nothing and runs no script' and 'Returns HTML to paste'. This reassures the agent about side effects and output. It does not detail auth or edge cases, but none are critical here.

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?

Three short sentences, each earning its place: purpose, eligibility condition, and safety/output note. The most important information is front-loaded with no fluff or repetition.

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 single-parameter, read-only tool with an output schema and annotations, the description covers when to use it, eligibility, output type, and safety behavior. Nothing an agent needs to correctly invoke the tool is missing.

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%, and the single url parameter is already well documented in the schema. The description adds no additional information about the parameter format or constraints, so the baseline score of 3 applies.

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?

States a specific verb and resource: 'Get the HTML snippet for a site's Agent Readiness badge'. The intended use (placing the badge on the site) is made explicit, and the operation is clearly distinct from the sibling tools explain_check and list_checks even without naming them.

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?

Provides clear conditions for use: 'Use when the user has a passing score and wants to display it', plus eligibility context ('Sites at grade C or better'). It does not explicitly name alternatives or say when not to use it, so it falls just short of a 5.

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.

TDQS

A4.4/5.0
Disambiguation5/5

Each tool targets a clear, distinct action: scoring a site, listing checks, explaining a single check, fetching badge HTML, and setting up monitoring. The descriptions include explicit usage guidance that removes any ambiguity.

Naming Consistency5/5

All tool names follow a consistent verb_noun snake_case pattern: explain_check, get_badge_embed, list_checks, score_site, watch_site. The naming is uniform and predictable.

Tool Count5/5

Five tools is well-scoped for a focused agent-readiness scoring service. Each tool contributes a distinct part of the workflow without redundancy or bloat.

Completeness4/5

The surface covers the core workflow: score, understand checks, explain findings, get a badge, and monitor a site. A minor gap is lack of a way to cancel or remove an active watch.

Resources