advance_test_clock

Moves a test clock forward using the clock.id returned by create_test_clock or read_test_clock. Time cannot move backwards; transactions and goal contributions…

Use with an AI agent

Export this page as Markdown or bundle it with a task for your agent.

Try a task
0 charactersPage docs attached
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": "advance_test_clock",
    "arguments": {
      "id": "demo_id_01",
      "frozenTime": "Example frozenTime"
    }
  }
}

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

Description

Moves a test clock forward using the clock.id returned by create_test_clock or read_test_clock. Time cannot move backwards; transactions and goal contributions scheduled up to the new time become posted in the clock snapshot.

Input parameters

NameTypeRequiredDescription
frozenTimestringYes
idstringYes
Full input schema (JSON Schema)
json
{
  "additionalProperties": false,
  "properties": {
    "frozenTime": {
      "type": "string"
    },
    "id": {
      "type": "string"
    }
  },
  "required": [
    "id",
    "frozenTime"
  ],
  "type": "object"
}