read_goal

Reads one saving goal by savingGoalId 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: 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": "read_goal",
    "arguments": {}
  }
}

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

Description

Reads one saving goal by savingGoalId for the authenticated user.

Use this when you already have a savingGoalId (from list_goals or create_goal) and need full goal details.

If savingGoalId is unknown, pass goalName with the goal name (or hint like "vacation"), or call list_goals first and use goal.id.

Input parameters

NameTypeRequiredDescription
goalNamestringNo
savingGoalIdstringNo
Full input schema (JSON Schema)
json
{
  "additionalProperties": false,
  "properties": {
    "goalName": {
      "type": [
        "null",
        "string"
      ]
    },
    "savingGoalId": {
      "type": "string"
    }
  },
  "type": "object"
}