Creates a new saving goal for the authenticated user.
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: Creates data
- Required scope:
write(themcpscope 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.
{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "create_goal",
"arguments": {
"name": "Emergency fund"
}
}
}Example IDs refer to fictional demo data. Replace them with IDs from your account before calling the real server.
Description
Creates a new saving goal for the authenticated user.
Required fields: name and an explicit target amount. amount and contributors[].contributorAmount are in CENTS, not dollars: $10,000 = 1000000. An amount written in the user's request may be parsed from the name; do not estimate targets from purchase categories, profile data, or spending history.
goalType defaults to GENERAL_SAVINGS and is inferred as HOME_PURCHASE only when the name clearly refers to a property purchase. maturityDate defaults to one year from now; explicit relative timelines (e.g. "in 18 months") are honored. contributorAmount defaults to amount.
HOME_PURCHASE and CAR_PURCHASE require user-provided purchase preferences or loanPreferences. Provide the down-payment amount or percentage and any loan terms the user specifies; do not infer them from age, location, spending, or market benchmarks.
accountId, when provided, must belong to the authenticated user (owner or collaborator).
The goal is created with the authenticated user as its only contributor, as OWNER_ROLE: contributors may only reference the authenticated user (other identities are rejected), and a role given for that entry is ignored.
Use this when users want to save toward a target (yacht, car, wedding, house, emergency fund, etc.).
For HOME_PURCHASE or CAR_PURCHASE goals, include the matching preference object when you have explicit values.
The create response includes savingGoalId. Use it for a later action only when the user requests one.Input parameters
| Name | Type | Required | Description |
|---|---|---|---|
accountId | string | No | |
amount | number | No | |
carPurchasePreferences | object | No | |
contributors | array | No | |
debtPaymentRecurrenceRate | string | No | |
goalImageId | string | No | |
goalType | string | No | |
homePurchasePreferences | object | No | |
loanPreferences | object | No | |
maturityDate | string | No | |
name | string | Yes | |
numberOfChildren | integer | No | |
startSavingsDate | string | No | |
targetAmount | number | No | |
targetDate | string | No |
Full input schema (JSON Schema)
{
"additionalProperties": false,
"properties": {
"accountId": {
"type": [
"null",
"string"
]
},
"amount": {
"type": [
"null",
"number"
]
},
"carPurchasePreferences": {
"additionalProperties": false,
"properties": {
"autoLoanPreferences": {
"additionalProperties": false,
"properties": {
"amortizationDuration": {
"type": "number"
},
"downPaymentAmount": {
"type": [
"null",
"number"
]
},
"downPaymentPercentage": {
"type": [
"null",
"number"
]
},
"interestRatePercentage": {
"type": "number"
},
"loanDurationTimeInterval": {
"type": [
"null",
"string"
]
}
},
"required": [
"interestRatePercentage",
"amortizationDuration"
],
"type": [
"null",
"object"
]
}
},
"type": [
"null",
"object"
]
},
"contributors": {
"items": {
"additionalProperties": false,
"properties": {
"contributions": {
"items": {
"additionalProperties": false,
"properties": {
"amount": {
"type": "number"
},
"date": {
"type": "string"
}
},
"required": [
"date",
"amount"
],
"type": "object"
},
"type": [
"null",
"array"
]
},
"contributorAmount": {
"type": "number"
},
"role": {
"type": "string"
},
"userId": {
"type": "string"
}
},
"required": [
"userId",
"role",
"contributorAmount"
],
"type": "object"
},
"type": [
"null",
"array"
]
},
"debtPaymentRecurrenceRate": {
"type": [
"null",
"string"
]
},
"goalImageId": {
"type": [
"null",
"string"
]
},
"goalType": {
"type": [
"null",
"string"
]
},
"homePurchasePreferences": {
"additionalProperties": false,
"properties": {
"mortgagePreferences": {
"additionalProperties": false,
"properties": {
"amortizationDuration": {
"type": "number"
},
"downPaymentAmount": {
"type": [
"null",
"number"
]
},
"downPaymentPercentage": {
"type": [
"null",
"number"
]
},
"interestRatePercentage": {
"type": "number"
},
"loanDurationTimeInterval": {
"type": [
"null",
"string"
]
}
},
"required": [
"interestRatePercentage",
"amortizationDuration"
],
"type": [
"null",
"object"
]
}
},
"type": [
"null",
"object"
]
},
"loanPreferences": {
"additionalProperties": false,
"properties": {
"amortizationDuration": {
"type": [
"null",
"number"
]
},
"downPaymentAmount": {
"type": "number"
},
"downPaymentPercentage": {
"type": "number"
},
"interestRatePercentage": {
"type": [
"null",
"number"
]
},
"loanDurationTimeInterval": {
"type": [
"null",
"string"
]
}
},
"required": [
"downPaymentAmount",
"downPaymentPercentage"
],
"type": [
"null",
"object"
]
},
"maturityDate": {
"type": [
"null",
"string"
]
},
"name": {
"type": "string"
},
"numberOfChildren": {
"type": [
"null",
"integer"
]
},
"startSavingsDate": {
"type": [
"null",
"string"
]
},
"targetAmount": {
"type": [
"null",
"number"
]
},
"targetDate": {
"type": [
"null",
"string"
]
}
},
"required": [
"name"
],
"type": "object"
}