Skip to main content
Glama

supportpages_set_repository_reminders

Enable or disable optional repository connection reminders for the bound help centre across local checkouts. Disabling persists until re-enabled and does not affect docs generation or publishing.

Instructions

Enable or disable optional repository connection reminders when the user asks. Applies to the bound help centre across local checkouts on this device, for this API origin. Disabling lasts until explicitly enabled again; it does not affect article generation or publication.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
enabledYes
workspaceNo

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
errorNo
resultNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.5.7

TDQS

B3.4/5.0
Behavior4/5

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

Annotations already establish the safety profile (readOnlyHint=false, destructiveHint=false, openWorldHint=false). The description adds genuinely useful behavior beyond that: disabling persists 'until explicitly enabled again' and it 'does not affect article generation or publication' — clarifying persistence and non-impact.

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?

Three tight sentences, front-loaded with the core action and followed by scope and behavioral caveats. Every sentence carries information; no filler or repetition.

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?

With an output schema present, return values need not be explained, and the annotations plus scope/persistence notes make the tool mostly callable. The notable gap is the unexplained `workspace` parameter and its tension with the 'bound help centre' framing, which an agent cannot resolve from the description alone.

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?

Schema description coverage is 0%, so the description carries the full burden. It implies the boolean `enabled` via 'Enable or disable', but never explains the `workspace` parameter or its relationship to the apparently 'bound help centre' scope, leaving half the parameters undocumented.

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 (enable/disable) and resource (optional repository connection reminders), with the scope ('bound help centre across local checkouts on this device, for this API origin') narrowing it further. It is distinguishable from the sibling supportpages_set_hosting_reminders by naming 'repository connection' rather than hosting, though that contrast is left implicit.

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?

'when the user asks' gives a trigger condition for invocation. However, no alternatives are named (e.g., set_hosting_reminders or set_telemetry for other reminder classes) and there is no 'when not to use' guidance, so the routing between the several 'set_*reminders' siblings must be inferred.

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