update_goal

Updates one saving goal by savingGoalId for the authenticated user. Wraps the updateSavingGoal RPC.

Use with an AI agent

Export this page as Markdown or bundle it with a task for your agent.

Try a task
Preview the prompt that will be copied

Access

  • Effect: Changes data
  • Required scope: write (the mcp scope also grants it)

Example request

The JSON-RPC message an MCP client sends to call this tool. Your client builds it for you; this is for reference and debugging in a tool such as MCP Inspector.

json
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "update_goal",
    "arguments": {
      "savingGoal": {}
    }
  }
}

Example IDs refer to fictional demo data. Replace them with IDs from your account before calling the real server.

Description

Updates one saving goal by savingGoalId for the authenticated user. Wraps the updateSavingGoal RPC.

If savingGoalId is unknown, pass goalName with the current goal name (or hint like "vacation").

Get savingGoalId from list_goals, read_goal, or create_goal.
savingGoal.amount is in CENTS, not dollars: $10,000 = 1000000.
If savingGoalFieldMasks is omitted, masks are inferred from the provided savingGoal fields.

Input parameters

NameTypeRequiredDescription
goalNamestringNo
savingGoalobjectYes
savingGoalFieldMasksarrayNo
savingGoalIdstringNo
Full input schema (JSON Schema)
json
{
  "additionalProperties": false,
  "properties": {
    "goalName": {
      "type": [
        "null",
        "string"
      ]
    },
    "savingGoal": {
      "additionalProperties": false,
      "properties": {
        "accountId": {
          "type": [
            "null",
            "string"
          ]
        },
        "amount": {
          "type": [
            "null",
            "number"
          ]
        },
        "carPurchasePreferences": {
          "additionalProperties": false,
          "properties": {
            "autoLoanPreferences": {
              "additionalProperties": false,
              "properties": {
                "amortizationDuration": {
                  "type": [
                    "null",
                    "number"
                  ]
                },
                "downPaymentAmount": {
                  "type": [
                    "null",
                    "number"
                  ]
                },
                "downPaymentPercentage": {
                  "type": [
                    "null",
                    "number"
                  ]
                },
                "interestRatePercentage": {
                  "type": [
                    "null",
                    "number"
                  ]
                },
                "loanDurationTimeInterval": {
                  "type": [
                    "null",
                    "string"
                  ]
                }
              },
              "type": [
                "null",
                "object"
              ]
            }
          },
          "type": [
            "null",
            "object"
          ]
        },
        "currency": {
          "type": [
            "null",
            "string"
          ]
        },
        "currentAmount": {
          "type": [
            "null",
            "number"
          ]
        },
        "debtPaymentRecurrenceRate": {
          "type": [
            "null",
            "string"
          ]
        },
        "description": {
          "type": [
            "null",
            "string"
          ]
        },
        "goalImageId": {
          "type": [
            "null",
            "string"
          ]
        },
        "goalType": {
          "type": [
            "null",
            "string"
          ]
        },
        "homePurchasePreferences": {
          "additionalProperties": false,
          "properties": {
            "mortgagePreferences": {
              "additionalProperties": false,
              "properties": {
                "amortizationDuration": {
                  "type": [
                    "null",
                    "number"
                  ]
                },
                "downPaymentAmount": {
                  "type": [
                    "null",
                    "number"
                  ]
                },
                "downPaymentPercentage": {
                  "type": [
                    "null",
                    "number"
                  ]
                },
                "interestRatePercentage": {
                  "type": [
                    "null",
                    "number"
                  ]
                },
                "loanDurationTimeInterval": {
                  "type": [
                    "null",
                    "string"
                  ]
                }
              },
              "type": [
                "null",
                "object"
              ]
            }
          },
          "type": [
            "null",
            "object"
          ]
        },
        "isActive": {
          "type": [
            "null",
            "boolean"
          ]
        },
        "loanPreferences": {
          "additionalProperties": false,
          "properties": {
            "amortizationDuration": {
              "type": [
                "null",
                "number"
              ]
            },
            "downPaymentAmount": {
              "type": [
                "null",
                "number"
              ]
            },
            "downPaymentPercentage": {
              "type": [
                "null",
                "number"
              ]
            },
            "interestRatePercentage": {
              "type": [
                "null",
                "number"
              ]
            },
            "loanDurationTimeInterval": {
              "type": [
                "null",
                "string"
              ]
            }
          },
          "type": [
            "null",
            "object"
          ]
        },
        "maturityDate": {
          "type": [
            "null",
            "string"
          ]
        },
        "name": {
          "type": [
            "null",
            "string"
          ]
        },
        "numberOfChildren": {
          "type": [
            "null",
            "integer"
          ]
        },
        "savingAnnualInterestRate": {
          "type": [
            "null",
            "number"
          ]
        },
        "savingFrequency": {
          "type": [
            "null",
            "string"
          ]
        },
        "startSavingsDate": {
          "type": [
            "null",
            "string"
          ]
        },
        "targetAmount": {
          "type": [
            "null",
            "number"
          ]
        },
        "targetDate": {
          "type": [
            "null",
            "string"
          ]
        }
      },
      "type": "object"
    },
    "savingGoalFieldMasks": {
      "items": {
        "additionalProperties": false,
        "properties": {
          "path": {
            "type": "string"
          }
        },
        "required": [
          "path"
        ],
        "type": "object"
      },
      "type": [
        "null",
        "array"
      ]
    },
    "savingGoalId": {
      "type": "string"
    }
  },
  "required": [
    "savingGoal"
  ],
  "type": "object"
}