Skip to main content
Glama

Update Scan Schedule

update_scan_schedule
Destructive

Edit a brand Site’s automatic Scan schedule. Read get_scan_config first. frequency and enabled are partial edits: omission preserves each setting. Confirm with the user before enabling or increasing recurring allowance commitment. Requires frequency, enabled, or both; Topics support manual scans only and are refused. timeZone is an optional valid IANA zone for calculating the next run when the effective schedule changes; it is not persisted and defaults to UTC. A timezone-only edit is refused. Returns the saved schedule/configuration; this call does not trigger a manual Scan. After uncertainty inspect get_scan_config before retrying.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
siteIdYesSite or topic ID from list_sites_and_topics. Check subjectKind; topics support manual baseline scans.
enabledNo
timeZoneNoIANA time zone for the next run time. Defaults to UTC.
frequencyNo

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
summaryYes
scanConfigYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.8/5.0
Behavior5/5

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

Annotations only give readOnlyHint=false and destructiveHint=true; the description adds the substantive behavioral detail: partial-edit semantics, the user-confirmation requirement for commitment increases, refusal conditions, timeZone non-persistence with UTC default, and that no manual Scan is triggered. This goes well beyond what the hints convey.

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 purpose, then constraints, then return/retry behavior. Almost every sentence is functional, but the run-on clauses around timeZone and the somewhat vague 'After uncertainty inspect get_scan_config before retrying' could be tightened.

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?

Covers prerequisites, exclusions, parameter interactions, confirmation requirement, persistence behavior, and return semantics, and an output schema already exists so return details need not be expanded. Nothing an agent needs to invoke this correctly is missing.

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 50%, and the description compensates meaningfully: 'frequency and enabled are partial edits: omission preserves each setting' and the timeZone clause adds that it is not persisted and only affects the next-run calculation. It adds real semantics beyond the schema, though siteId's meaning is left entirely to the schema.

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 plus scope: 'Edit a brand Site's automatic Scan schedule.' It explicitly distinguishes itself from get_scan_config (read first) and trigger_scan ('this call does not trigger a manual Scan'), so an agent can route correctly without opening schemas.

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

Usage Guidelines5/5

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

Gives an explicit prerequisite (read get_scan_config first), clear exclusions (Topics are refused; a timezone-only edit is refused), and a required operating condition (confirm with the user before enabling or increasing recurring commitment). The alternative and the conditions that select it are named.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources