list_goals

Lists every saving goal for the authenticated user across all life plans.

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: Read-only
  • Required scope: read (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": "list_goals",
    "arguments": {}
  }
}

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

Description

Lists every saving goal for the authenticated user across all life plans.

Call this first when you need a savingGoalId for any other goal tool:
  • read_goal requires savingGoalId — use goal.id from this response.
  • delete_goal requires savingGoalId — use goal.id from this response.

Use this when users ask to see their goals, savings targets, or progress toward a purchase.

Input parameters

NameTypeRequiredDescription
limitintegerNo
skipintegerNo
Full input schema (JSON Schema)
json
{
  "additionalProperties": false,
  "properties": {
    "limit": {
      "type": [
        "null",
        "integer"
      ]
    },
    "skip": {
      "type": [
        "null",
        "integer"
      ]
    }
  },
  "type": "object"
}