Skip to main content
Glama

facts.badge

Read-only

shields.io endpoint JSON for one subject, derived from the fact table — «no facts» in grey when nothing is recorded, never rounded up.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
domainYes
subjectYesSubject key (e.g. «slug#0»).

Schema Changelog

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

  1. First observed

TDQS

B3.3/5.0
Behavior4/5

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

Annotations already mark the tool as read-only. The description adds two useful behavioral details beyond that: the empty-record rendering ('«no facts» in grey') and the precision guarantee ('never rounded up'). It does not mention auth or rate limits, but the read-only annotation lowers the burden.

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?

The description is a single front-loaded sentence. It states the endpoint type, the scope, and both edge-case behaviors without waste.

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?

For a simple read-only badge endpoint, the description plus annotations cover the core return type and safety profile. However, the missing domain semantics and lack of usage guidance leave an agent uncertain how to construct valid calls. Thus it is minimally complete but not robust.

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

Parameters2/5

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

The schema documents only 'subject' with an example; 'domain' has no description and the tool description does not explain it either. The phrase 'one subject' does not clarify what domain values are valid or how subjects are keyed beyond the schema example. With only 50% schema coverage, the description should compensate but does not.

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 identifies the tool as a shields.io endpoint that returns JSON for one subject from the fact table, so an agent knows the deliverable. It does not use an explicit verb such as 'returns' or 'gets', and it does not explicitly contrast with facts.latest, though 'one subject' helps scope it.

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?

No guidance is given about when to choose this tool over facts.latest or other siblings. 'Derived from the fact table' is context but not an explicit when-to-use statement. Prerequisites and exclusions are absent.

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.

Resources