Skip to main content
Glama

taxapp.nz

Schedule a report

create_scheduled_report

Sets up a report to be emailed to a contact regularly, or once. The report comes from list_scheduled_report_types, the recipient and anyone copied from list_contacts (each needs an email address). Confirm the report, recipient and timing with the person before setting it up: it emails someone outside taxapp. 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 saved schedule with the date it first goes.

Input Schema

NameRequiredDescriptionDefault
nameYesA name for the schedule, such as "Monthly statement to Jo".
enabledNofalse to save it switched off.
frequencyYesHow 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_keyYesThe 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.
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.
recipient_contact_idYesThe 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.5/5.0
Behavior5/5

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

Annotations only cover the generic mutation profile (readOnlyHint=false, idempotentHint=false, destructiveHint=false). The description adds high-value behavior the annotations cannot: this tool sends email to an external party, requires organisation-owner privileges, requires a write-enabled connection, and should be confirmed with the user first. It also states the return value ('the saved schedule with the date it first goes'), which is absent from annotations and there is no output schema.

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?

The purpose is front-loaded and each subsequent sentence carries a real constraint (permissions, connection scope, confirmation, sourcing, return value) rather than filler. It runs slightly long at six sentences for a description whose schema already covers most field-level detail, but nothing is redundant.

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 16-parameter mutation tool with no output schema and no field-level gaps in the schema, the description covers the non-schema essentials: authorization level, connection permission requirement, prerequisite lookups, the external-email side effect, and the shape of the response. An agent has what it needs to call this correctly or to decline.

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 description coverage is 100%, so the baseline is 3; the description still adds the non-obvious constraint that recipient and cc contacts each need an email address, and ties report_key/recipient/cc back to their source list tools. It does not add anything about the timing parameters (day_of_week, day_of_month, send_time, one-off dates), which remain schema-only.

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?

The opening sentence gives a specific verb and resource — it creates a recurring or one-off emailed report schedule — which an agent can act on immediately. It does not explicitly distinguish itself from the sibling update_scheduled_report or send_scheduled_report_now, so the create-vs-modify-vs-send boundary must be inferred.

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?

Explicit prerequisites are stated: only an organisation owner can see or set up schedules, the connection must be permitted to add/change records in that organisation, and the recipient/cc contacts must each have an email address. It also names the upstream tools (list_scheduled_report_types, list_contacts, list_organisations) that must be called first, plus a human-confirmation step before sending mail outside the app.

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.