Creates an income projection (expected future income).
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_income_projection",
"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 an income projection (expected future income).
Requires name. The name may be a natural-language request (e.g. "Add a $5000/month salary income projection"): the amount ($5000, $5k), repeatFrequency (MONTHLY or YEARLY) and category are inferred from it, startMonth defaults to the current month, and the stored name is cleaned ("Salary").
If no amount is given or inferred, or the cadence is weekly/biweekly (unsupported), it returns guidance instead of creating.
startMonth is ISO 8601 (e.g. 2024-01-01T00:00:00Z). amount is cents. repeatFrequency is NO_REPEAT, MONTHLY, YEARLY, or CUSTOM.
The create response reports the created projection.Input parameters
| Name | Type | Required | Description |
|---|---|---|---|
amount | integer | No | |
category | string | No | |
customRepeatFrequency | object | No | |
endMonth | string | No | |
name | string | Yes | |
overrides | array | No | |
repeatFrequency | string | No | |
startMonth | string | No |
Full input schema (JSON Schema)
{
"additionalProperties": false,
"properties": {
"amount": {
"type": "integer"
},
"category": {
"type": "string"
},
"customRepeatFrequency": {
"additionalProperties": false,
"properties": {
"frequencyAmount": {
"type": "integer"
},
"frequencyUnit": {
"type": "string"
}
},
"required": [
"frequencyUnit",
"frequencyAmount"
],
"type": [
"null",
"object"
]
},
"endMonth": {
"type": [
"null",
"string"
]
},
"name": {
"type": "string"
},
"overrides": {
"items": {
"additionalProperties": false,
"properties": {
"amount": {
"type": "integer"
},
"customRepeatFrequency": {
"additionalProperties": false,
"properties": {
"frequencyAmount": {
"type": "integer"
},
"frequencyUnit": {
"type": "string"
}
},
"required": [
"frequencyUnit",
"frequencyAmount"
],
"type": [
"null",
"object"
]
},
"endMonth": {
"type": [
"null",
"string"
]
},
"repeatFrequency": {
"type": "string"
},
"startMonth": {
"type": "string"
}
},
"required": [
"startMonth",
"amount",
"repeatFrequency"
],
"type": "object"
},
"type": [
"null",
"array"
]
},
"repeatFrequency": {
"type": "string"
},
"startMonth": {
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
}