Skip to main content
Glama

writ_badge_token

Mint a public badge token for the tenant and return its embed snippet.

Instructions

Mint a public badge token for the tenant and return its embed snippet.

The badge renders the tenant's live gated-write count over the trailing 30 days. The token is shown exactly once: store it, it is needed to revoke the badge. It is public by design (it lives in a README image URL) and cannot be used as an API key. See https://docs.withwrit.com/readme-badge for the verification model.

Args: label: Optional private label for your own bookkeeping (max 40 chars, letters/digits/space/_/.-). Never rendered on the badge.

Returns the gate payload verbatim: badgeToken (writ_badge_...), badgeUrl, markdown (ready-to-paste README snippet), label, and a note.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "writ_badge_token"
  }
}

Input Schema

NameRequiredDescriptionDefault
labelNo

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv0.2.20

TDQS

A4.2/5.0
Behavior3/5

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

With no annotations, the description carries the full burden and does well: it discloses that the token is shown exactly once and must be stored, that it is required to revoke the badge, that it is public-safe, and that the badge reflects a trailing 30-day window. What it does not cover is mutation semantics in annotation terms (idempotency, whether re-minting invalidates prior tokens, or permission requirements for minting).

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?

Front-loaded with the action in sentence one, followed by behavioral constraints and then Args/Returns. The Returns section largely restates what an output schema already provides (badgeToken, badgeUrl, markdown, label), which is mild redundancy but the phrasing stays tight.

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 one-parameter mint tool with no annotations, this covers the essentials an agent needs: what it produces, one-time visibility of the secret, what it must be stored for, its safety profile, and a doc link for the verification model. An output schema exists, so the added return enumeration is bonus rather than a gap-filler.

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

Parameters4/5

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

Schema coverage is 0%, so the description must compensate, and it does: label is optional, private, max 40 characters, restricted to letters/digits/space/_/.-, and never rendered on the badge. That is nearly complete semantics for the single parameter, missing only whether an empty label is normalized to null.

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 ('Mint a public badge token for the tenant') plus its output ('return its embed snippet'). It also implicitly separates itself from writ_badge_revoke by noting the token 'is needed to revoke the badge', so an agent can distinguish the two without opening either schema.

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?

Implied usage is clear: generating a README embed snippet for the tenant's gated-write count. It adds a useful negative constraint ('cannot be used as an API key', 'public by design'), but never explicitly says when to prefer this over siblings like writ_verify_token or when not to mint one at all.

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