Skip to main content
Glama

taxapp.nz

Change a scheduled report

update_scheduled_report
DestructiveIdempotent

Changes a scheduled report, by its id from list_scheduled_reports: its name, report, recipient, who is copied, how often and when it goes, or switches it off or on. Give only what changes: every parameter left out keeps the value the record has now. Read the record first, and confirm the change with the person before making it. Only an owner of the organisation can see and set up scheduled reports. Only for an organisation where this connection may add and change records (list_organisations says which). The answer is the changed schedule.

Input Schema

NameRequiredDescriptionDefault
nameNoA name for the schedule.
clearNoOptional fields to empty, by parameter name, any of: cc_contact_ids.
enabledNofalse to switch it off, true to switch it on again.
frequencyNoHow often it goes: Daily, Weekly (give day_of_week), Monthly or Quarterly (give day_of_month), or OneOff (give one_off_date, period_start and period_end).
send_timeNoThe New Zealand time of day it goes, 24-hour HH:mm. 07:00 when left out.
period_endNoOneOff only: the last New Zealand date the report covers, yyyy-MM-dd.
report_keyNoThe report's key, from list_scheduled_report_types.
tenancy_idNoFor a report about a tenancy: its id, from list_properties.
day_of_weekNoWeekly only: the day it goes.
property_idNoFor a report about a property: its id, from list_properties. The only property when left out.
day_of_monthNoMonthly and quarterly only: the day of the month it goes, 1 to 28.
one_off_dateNoOneOff only: the New Zealand date it goes, yyyy-MM-dd.
period_startNoOneOff only: the first New Zealand date the report covers, yyyy-MM-dd.
cc_contact_idsNoContacts copied on every email, from list_contacts; each needs an email address. Replaces the list it has now.
organisation_idNoThe id of the organisation to use, from list_organisations. Leave it out when the connection covers only one organisation; it is required when it covers more than one.
scheduled_report_idYesThe schedule's id, from list_scheduled_reports.
recipient_contact_idNoThe contact it is emailed to, from list_contacts.
contractor_contact_idNoFor a report about a contractor: their contact id, from list_contacts. The only contractor when left out.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A4.3/5.0
Behavior4/5

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

Annotations already declare the safety profile (readOnlyHint=false, destructiveHint=true, idempotentHint=true), and the description adds genuinely new behavior: partial-update semantics (omitted parameters keep current values), the read-first/confirm workflow, the owner permission requirement, and the return value. It never explains the destructiveHint=true rating or what is overwritten when a field list is replaced, which keeps it from a 5.

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?

Purpose and the changeable fields are front-loaded; the partial-update rule follows immediately. Five sentences with little redundancy, though the opening sentence is dense and the 'by its id from list_scheduled_reports' clause interrupts the field list.

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 an 18-parameter mutation tool with no output schema and full schema coverage, the description covers prerequisites, permission gating, partial-update behavior, and the return value, which is enough to call it correctly. Minor gaps remain around the 'clear' parameter and the destructive potential of replacing field lists.

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 100%, so baseline is 3, and the description adds a cross-cutting rule the schema cannot express: supply only what changes, since every omitted parameter retains the record's current value. It also enumerates the changeable field groups, though it omits the 'clear' parameter and cc-replacement semantics.

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 (changes) plus the resource (a scheduled report identified by id) and enumerates exactly which fields can change: name, report, recipient, cc, frequency/timing, and on/off state. An agent can distinguish it from create_scheduled_report and list_scheduled_reports without opening the 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?

Gives real operating context: read the record first, confirm with the person, owner-only visibility, and that the organisation must be one where the connection may add and change records. It does not name a sibling alternative (e.g. send_scheduled_report_now) or state when not to use this tool, so it stops short of a 5.

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.