Skip to main content
Glama

Hide or show badge

set_badge

Hide or show the BrewPage badge on a publication using an owner token; omit the hidden flag to check the current badge state.

Instructions

Hide or show the BrewPage badge on a publication. Needs an owner token that is in a BrewPage profile (free sign-in at https://account.brewpage.app); up to 5 hidden per profile.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "type": "<type>",
      "namespace": "<namespace>",
      "id": "<id>"
    },
    "name": "set_badge"
  }
}

Input Schema

NameRequiredDescriptionDefault
idYesPublication ID
typeYesPublication type
hiddenNotrue = hide the badge, false = show it. Omit: report the current state.
namespaceYesPublication namespace
ownerTokenNoOwner token from create. Default: env BREWPAGE_OWNER_TOKEN (local server only).

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv1.21.0

TDQS

A3.8/5.0
Behavior4/5

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

Annotations declare a non-read-only, non-destructive mutation; the description adds real context beyond them: the auth prerequisite with a sign-in link, plus a per-profile cap of 5 hidden badges. It does not state what happens when the cap is reached or whether the operation is reversible.

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?

Two sentences, action first, prerequisites second, with no redundant restatement of the title or schema fields. Every clause carries information.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a five-parameter toggle with full schema coverage and no output schema, the description plus annotations cover the essentials: what changes, who can do it, and the quota. Only failure modes at the 5-hidden limit are unaddressed.

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 coverage is 100%, including an explicit enum for type and a description for hidden that covers the omit-means-report behavior, so the description need not compensate. It adds no parameter meaning of its own beyond the schema baseline.

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?

States a specific verb pair (hide/show) and resource (the BrewPage badge on a publication), which is concrete enough to distinguish it from the visibility/privacy siblings. It stops short of naming those siblings, so the agent must infer the boundary itself.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Provides useful preconditions (owner token from a BrewPage profile, quota of 5 hidden per profile) that tell the agent when the call can succeed. However, it gives no explicit comparison with set_visibility or make_private, and no guidance on failures when the quota is exhausted.

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