Skip to main content
Glama

Edit or pause a fixed cost

recurring_update

Edit a fixed-cost template or pause and resume its recurring bookings by sending only the fields to change. Use it for updates and pausing; resuming skips missed cycles.

Instructions

Change a fixed-cost template or pause and resume it (paused). Send only the fields to change; at least one is required (400 invalid_body otherwise). Use it for edits and pausing; to skip one cycle use recurring_advance, to remove the template for good use recurring_delete. Only the creator of the template or a flat admin may call it, others get 403 not_owner. Resuming does not book the missed cycles: the due date jumps to the next cycle day from today. Changing amountCents, paidByMemberId or splits is checked like recurring_create (403 paid_by_must_include_caller, 400 splits_sum_mismatch). Pass expectedNextDueAt to guard against concurrent edits or bookings: if the template moved meanwhile, the call fails with 409 recurring_expense_changed and nothing is written; read it again with recurring_get and decide. Returns the updated template as recurringExpense.

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": {
      "id": "<id>"
    },
    "name": "recurring_update"
  }
}

Input Schema

NameRequiredDescriptionDefault
idYesId of the fixed-cost template, as returned in recurringExpenses[].id by recurring_list or in recurringExpense.id by recurring_create.
pausedNotrue pauses the template (no automatic bookings), false resumes it. Omit to leave the pause state as it is.
splitsNoWho owes what per charge, one entry per member. Amounts must add up to amountCents. Member ids come from members_list. Replaces the whole list.
wgCodeNoShare code of the flat (code from wg_list). Leave it out when the account belongs to one flat.
categoryNoNew category for booked expenses.
currencyNoFixed-cost templates are always in EUR, which is the only accepted value (the app rejects others with recurring_currency_unsupported). Omit it.
nextDueAtNoMove the next due date, ISO 8601 with offset. Must lie within 366 days in the past and 10 years ahead. Sending the unchanged value is harmless.
amountCentsNoNew amount per charge in cents of EUR. If you change it, also send splits that add up to it unless the current splits already do.
descriptionNoNew label for the template.
intervalMonthsNoNew number of months between charges, for example 1 monthly or 12 yearly.
paidByMemberIdNoNew paying member, from members_list.
expectedNextDueAtNonextDueAt of the template as you last read it from recurring_get or recurring_list (ISO 8601 with offset). Used as a concurrency guard.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed6 schema fields changedv0.3.0
    • addedInput schema / properties / currency / const
      Added value: +"EUR"
    • changedInput schema / properties / currency / description
      Previous value: -"Only EUR is accepted by the app; any other value fails with recurring_currency_unsupported. Omit it."New value: +"Fixed-cost templates are always in EUR, which is the only accepted value (the app rejects others with recurring_currency_unsupported). Omit it."
    • removedInput schema / properties / currency / enum
      Removed value: -[
      -  "EUR",
      -  "CHF",
      -  "USD",
      -  "GBP"
      -]
    • removedInput schema / properties / splits / items / description
      Removed value: -"One member share of each charge."
    • addedInput schema / properties / splits / items / properties / amountCents / description
      Added value: +"Share of this member in cents. All shares together must equal the total."
    • addedInput schema / properties / splits / items / properties / debtorMemberId / description
      Added value: +"Member who owes this share, from members_list. The payer may appear here to cover their own share."
  2. Changed12 schema fields changedv0.1.1
    • addedInput schema / properties / amountCents / description
      Added value: +"New amount per charge in cents of EUR. If you change it, also send splits that add up to it unless the current splits already do."
    • addedInput schema / properties / category / description
      Added value: +"New category for booked expenses."
    • addedInput schema / properties / currency / description
      Added value: +"Only EUR is accepted by the app; any other value fails with recurring_currency_unsupported. Omit it."
    • addedInput schema / properties / description / description
      Added value: +"New label for the template."
    • addedInput schema / properties / expectedNextDueAt / description
      Added value: +"nextDueAt of the template as you last read it from recurring_get or recurring_list (ISO 8601 with offset). Used as a concurrency guard."
    • addedInput schema / properties / id / description
      Added value: +"Id of the fixed-cost template, as returned in recurringExpenses[].id by recurring_list or in recurringExpense.id by recurring_create."
    • addedInput schema / properties / intervalMonths / description
      Added value: +"New number of months between charges, for example 1 monthly or 12 yearly."
    • addedInput schema / properties / nextDueAt / description
      Added value: +"Move the next due date, ISO 8601 with offset. Must lie within 366 days in the past and 10 years ahead. Sending the unchanged value is harmless."
    • addedInput schema / properties / paidByMemberId / description
      Added value: +"New paying member, from members_list."
    • addedInput schema / properties / paused / description
      Added value: +"true pauses the template (no automatic bookings), false resumes it. Omit to leave the pause state as it is."
    • addedInput schema / properties / splits / description
      Added value: +"Who owes what per charge, one entry per member. Amounts must add up to amountCents. Member ids come from members_list. Replaces the whole list."
    • addedInput schema / properties / splits / items / description
      Added value: +"One member share of each charge."
  3. First observedv0.1.0

TDQS

A4.4/5.0
Behavior3/5

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

Annotation-bearing description: annotations already state readOnlyHint=false, destructiveHint=false and idempotentHint=false. The description goes well beyond them by disclosing concrete failure modes (400 invalid_body, 403 not_owner, 409 recurring_expense_changed), the partial-update contract, and the non-obvious resume rule that missed cycles are not booked and the due date jumps forward. This is rich behavioral context, so it scores above the annotation baseline.

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 core action, then alternatives, then permissions, then edge cases and the concurrency guard. Dense but nearly every clause carries operational value; the parenthetical error codes and the resume explanation justify their length.

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 12-parameter mutation with no output schema, the description covers the partial-update contract, auth, validation error codes, resume semantics, and the optimistic-concurrency workflow, and it names the return shape ('updated template as recurringExpense'). Nothing an agent needs to call it 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 100%, so the baseline is 3, but the description adds cross-field and conditional semantics the schema does not spell out: 'at least one field' requirement, that amountCents/paidByMemberId/splits changes are re-validated like recurring_create with the exact error codes, and the meaning of expectedNextDueAt as a read-then-guard pattern with recurring_get. It stops short of describing every parameter, hence 4 rather than 5.

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+resource ('Change a fixed-cost template or pause and resume it') and immediately scopes it against siblings recurring_advance and recurring_delete. An agent can distinguish edit/pause from skip-cycle/delete without opening any schema.

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?

Explicitly says to use it for edits and pausing, names recurring_advance for skipping one cycle and recurring_delete for permanent removal, and states the authorization rule ('only the creator ... or a flat admin'). Both when-to-use and when-not-to-use are covered.

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