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?
Annotations already declare readOnlyHint=true, idempotentHint=true, and destructiveHint=false, so the safety profile is covered. The description adds that the response includes both metadata and markdown of an SVG badge, which is useful context, but says nothing about format details or size/rate constraints.
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?
One short sentence, front-loaded with the core resource. It is terse but every word earns its place; it could be slightly more explicit about the verb.
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 carries some burden for describing return values, and it does so only minimally ('metadata and markdown'). For a simple single-param read tool with full annotation coverage, this is adequate but thin.
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 single slug parameter is documented in the schema as a '24-char public slug'. The description adds no further parameter meaning, so the baseline 3 applies.
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?
The description names a specific resource (metadata and markdown of the SVG badge of a shared report), so an agent knows exactly what comes back. It lacks explicit differentiation from siblings, but the sibling list (api_index, billing, run_tab, etc.) contains no overlapping badge-related tool to disambiguate against.
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 call this versus alternatives, nor any stated precondition beyond the required slug. The agent must infer usage entirely from the phrase 'shared report'.
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.