Get badge
get_badgeMetadata and markdown of the SVG badge of a shared report.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| slug | Yes | 24-char public slug |
get_badgeMetadata and markdown of the SVG badge of a shared report.
| Name | Required | Description | Default |
|---|---|---|---|
| slug | Yes | 24-char public slug |
Changes observed during successful MCP inspections.
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The annotations already declare readOnlyHint, idempotentHint and destructiveHint=false, so safety is covered. The description adds the useful detail that the payload includes markdown in addition to raw metadata, but it says nothing about access requirements for shared reports, size limits, or failure modes.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
A single front-loaded sentence with zero filler; the resource and return content appear immediately. It is a fragment rather than a full sentence, but nothing is wasted.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
With no output schema, the description must sketch the return value and it does so only vaguely ('metadata and markdown'). Combined with annotations covering the safety profile and full parameter documentation, it is adequate but leaves the agent guessing about exactly what 'metadata' contains and how the badge is delivered.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100% and the slug parameter is documented as a '24-char public slug', so the schema carries the burden. The description's reference to 'a shared report' loosely ties the slug to a report resource but adds no format or constraint detail beyond the schema.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
States a specific resource (the SVG badge of a shared report) and what it yields (metadata and markdown), which is concrete enough to distinguish it from most siblings. It never names an alternative tool and the verb is only implied by the name, so the differentiation is soft rather than explicit.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
There is no guidance on when to reach for this tool versus siblings such as embed_snippet or weekly_site_report, nor any prerequisite such as the report having been shared. The only context is the phrase 'of a shared report,' which hints at a precondition but doesn't state it as a rule.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Add one secure layer between your agents and this server.