update_projection

Updates an income or expense projection by projectionId. Wraps the updateProjection 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_projection",
    "arguments": {
      "projection": {}
    }
  }
}

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

Description

Updates an income or expense projection by projectionId. Wraps the updateProjection RPC.

Get projectionId from list_income_projections or list_expense_projections.
If projectionId is unknown, pass projectionName (current name). It resolves across income and expense projections to an exact case-insensitive match, or to the only projection whose name contains every word of projectionName; otherwise it returns the candidates to choose from.
If projectionFieldMasks is omitted, masks are inferred from the provided projection fields.

Input parameters

NameTypeRequiredDescription
projectionobjectYes
projectionFieldMasksarrayNo
projectionIdstringNo
projectionNamestringNo
Full input schema (JSON Schema)
json
{
  "additionalProperties": false,
  "properties": {
    "projection": {
      "additionalProperties": false,
      "properties": {
        "amount": {
          "type": [
            "null",
            "integer"
          ]
        },
        "category": {
          "type": [
            "null",
            "string"
          ]
        },
        "cronExpression": {
          "type": [
            "null",
            "string"
          ]
        },
        "customRepeatFrequency": {
          "additionalProperties": false,
          "properties": {
            "frequencyAmount": {
              "type": "integer"
            },
            "frequencyUnit": {
              "type": "string"
            }
          },
          "required": [
            "frequencyUnit",
            "frequencyAmount"
          ],
          "type": [
            "null",
            "object"
          ]
        },
        "description": {
          "type": [
            "null",
            "string"
          ]
        },
        "endMonth": {
          "items": {
            "maximum": 255,
            "minimum": 0,
            "type": "integer"
          },
          "type": [
            "null",
            "array"
          ]
        },
        "isActive": {
          "type": [
            "null",
            "boolean"
          ]
        },
        "isIncome": {
          "type": [
            "null",
            "boolean"
          ]
        },
        "name": {
          "type": [
            "null",
            "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": [
            "null",
            "string"
          ]
        },
        "rrule": {
          "type": [
            "null",
            "string"
          ]
        },
        "startMonth": {
          "type": [
            "null",
            "string"
          ]
        },
        "timezone": {
          "type": [
            "null",
            "string"
          ]
        }
      },
      "type": "object"
    },
    "projectionFieldMasks": {
      "items": {
        "additionalProperties": false,
        "properties": {
          "path": {
            "type": "string"
          }
        },
        "required": [
          "path"
        ],
        "type": "object"
      },
      "type": [
        "null",
        "array"
      ]
    },
    "projectionId": {
      "type": "string"
    },
    "projectionName": {
      "type": [
        "null",
        "string"
      ]
    }
  },
  "required": [
    "projection"
  ],
  "type": "object"
}