# MCP tool reference

1 callable tools.

Use tools/call at https://mcp.schedulerzero.com/mcp with the exact tool name and arguments below. The /tools/ paths in this view are documentation identifiers, not HTTP endpoints. Request execution is disabled for this reference.

Inputs are shown for personal API keys (bound) and for OAuth/delegated agents. Output schemas describe MCP structuredContent: native objects pass through; arrays, scalars and null use a data wrapper. Text content retains the native JSON result.

[Connect a client](/mcp/connect) · [Authentication and authorization](/authentication) · [Generated auth guide](/auth.md) · [Download tool catalog](/mcp-catalog.json) · [Agent documentation](/llms.txt)

## get_dashboard

Read a complete saved dashboard or query including SQL, chart types and columns, filters, text widgets, layout and revision.

Use before editing. Preserve widget IDs and unrelated settings; use the returned revision with save_dashboard.

Requires the Workspace SQL feature and the stated permission. This does not grant access to another Workspace or execute stored SQL automatically.

Scopes: sql:query

Risk: read; confirmation: none; idempotency: none.

### Input schema (personal API key)

```json
{
  "type": "object",
  "properties": {
    "workspaceId": {
      "type": "string",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
      "format": "uuid"
    },
    "dashboardId": {
      "type": "string",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
      "format": "uuid"
    }
  },
  "required": [
    "workspaceId",
    "dashboardId"
  ],
  "patternProperties": {
    "^(?!(?:workspaceId|dashboardId)$)[\\s\\S]*$": false
  },
  "additionalProperties": true,
  "propertyNames": {
    "type": "string",
    "enum": [
      "workspaceId",
      "dashboardId"
    ]
  }
}
```

### Input schema (OAuth / delegated agent)

```json
{
  "type": "object",
  "properties": {
    "workspaceId": {
      "type": "string",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
      "format": "uuid"
    },
    "dashboardId": {
      "type": "string",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
      "format": "uuid"
    }
  },
  "required": [
    "workspaceId",
    "dashboardId"
  ],
  "patternProperties": {
    "^(?!(?:workspaceId|dashboardId)$)[\\s\\S]*$": false
  },
  "additionalProperties": true,
  "propertyNames": {
    "type": "string",
    "enum": [
      "workspaceId",
      "dashboardId"
    ]
  }
}
```

### Output schema (structuredContent)

```json
{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
      "format": "uuid"
    },
    "workspaceId": {
      "type": "string",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
      "format": "uuid"
    },
    "ownerId": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ]
    },
    "revision": {
      "type": "integer",
      "minimum": 0,
      "maximum": 9007199254740991
    },
    "updatedAt": {
      "type": "string"
    },
    "document": {
      "type": "object",
      "properties": {
        "version": {
          "type": "number",
          "enum": [
            1
          ]
        },
        "kind": {
          "type": "string",
          "enum": [
            "dashboard",
            "query"
          ]
        },
        "name": {
          "type": "string",
          "maxLength": 160,
          "minLength": 1
        },
        "description": {
          "type": "string",
          "maxLength": 2000
        },
        "filters": {
          "type": "object",
          "properties": {
            "from": {
              "type": "string",
              "maxLength": 40
            },
            "to": {
              "type": "string",
              "maxLength": 40
            },
            "domain": {
              "type": "string",
              "maxLength": 253
            },
            "ip": {
              "type": "string",
              "maxLength": 64
            },
            "source": {
              "type": "string",
              "maxLength": 256
            }
          },
          "required": [
            "from",
            "to",
            "domain",
            "ip",
            "source"
          ],
          "patternProperties": {
            "^(?!(?:from|to|domain|ip|source)$)[\\s\\S]*$": false
          },
          "additionalProperties": true,
          "propertyNames": {
            "type": "string",
            "enum": [
              "from",
              "to",
              "domain",
              "ip",
              "source"
            ]
          }
        },
        "widgets": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
                "format": "uuid"
              },
              "kind": {
                "type": "string",
                "enum": [
                  "chart",
                  "text"
                ]
              },
              "title": {
                "type": "string",
                "maxLength": 160
              },
              "text": {
                "type": "string",
                "maxLength": 4000
              },
              "query": {
                "type": "string",
                "maxLength": 20000
              },
              "bindings": {
                "type": "array",
                "items": {
                  "type": "string",
                  "enum": [
                    "from",
                    "to",
                    "domain",
                    "ip",
                    "source"
                  ]
                },
                "maxItems": 32
              },
              "chart": {
                "type": "object",
                "properties": {
                  "type": {
                    "type": "string",
                    "enum": [
                      "table",
                      "number",
                      "line",
                      "area",
                      "bar"
                    ]
                  },
                  "dimension": {
                    "type": "string",
                    "maxLength": 128
                  },
                  "measures": {
                    "type": "array",
                    "items": {
                      "type": "string",
                      "maxLength": 128
                    },
                    "maxItems": 8
                  },
                  "format": {
                    "type": "string",
                    "enum": [
                      "number",
                      "percent",
                      "currency",
                      "duration",
                      "bytes"
                    ]
                  },
                  "decimals": {
                    "type": "integer",
                    "minimum": 0,
                    "maximum": 6
                  },
                  "label": {
                    "type": "string",
                    "maxLength": 128
                  }
                },
                "required": [
                  "type",
                  "dimension",
                  "measures",
                  "format",
                  "decimals",
                  "label"
                ],
                "patternProperties": {
                  "^(?!(?:type|dimension|measures|format|decimals|label)$)[\\s\\S]*$": false
                },
                "additionalProperties": true,
                "propertyNames": {
                  "type": "string",
                  "enum": [
                    "type",
                    "dimension",
                    "measures",
                    "format",
                    "decimals",
                    "label"
                  ]
                }
              },
              "layout": {
                "type": "object",
                "properties": {
                  "x": {
                    "type": "integer",
                    "minimum": 0,
                    "maximum": 11
                  },
                  "y": {
                    "type": "integer",
                    "minimum": 0,
                    "maximum": 500
                  },
                  "w": {
                    "type": "integer",
                    "minimum": 2,
                    "maximum": 12
                  },
                  "h": {
                    "type": "integer",
                    "minimum": 2,
                    "maximum": 12
                  }
                },
                "required": [
                  "x",
                  "y",
                  "w",
                  "h"
                ],
                "patternProperties": {
                  "^(?!(?:x|y|w|h)$)[\\s\\S]*$": false
                },
                "additionalProperties": true,
                "propertyNames": {
                  "type": "string",
                  "enum": [
                    "x",
                    "y",
                    "w",
                    "h"
                  ]
                }
              }
            },
            "required": [
              "id",
              "kind",
              "title",
              "text",
              "query",
              "bindings",
              "chart",
              "layout"
            ],
            "patternProperties": {
              "^(?!(?:id|kind|title|text|query|bindings|chart|layout)$)[\\s\\S]*$": false
            },
            "additionalProperties": true,
            "propertyNames": {
              "type": "string",
              "enum": [
                "id",
                "kind",
                "title",
                "text",
                "query",
                "bindings",
                "chart",
                "layout"
              ]
            }
          },
          "maxItems": 30
        }
      },
      "required": [
        "version",
        "kind",
        "name",
        "description",
        "filters",
        "widgets"
      ],
      "patternProperties": {
        "^(?!(?:version|kind|name|description|filters|widgets)$)[\\s\\S]*$": false
      },
      "additionalProperties": true,
      "propertyNames": {
        "type": "string",
        "enum": [
          "version",
          "kind",
          "name",
          "description",
          "filters",
          "widgets"
        ]
      }
    }
  },
  "required": [
    "id",
    "workspaceId",
    "ownerId",
    "revision",
    "updatedAt",
    "document"
  ],
  "patternProperties": {
    "^(?!(?:id|workspaceId|ownerId|revision|updatedAt|document)$)[\\s\\S]*$": false
  },
  "additionalProperties": true,
  "propertyNames": {
    "type": "string",
    "enum": [
      "id",
      "workspaceId",
      "ownerId",
      "revision",
      "updatedAt",
      "document"
    ]
  }
}
```

### Underlying API operations

- `dashboards.get`: `GET /v1/workspaces/:workspaceId/dashboards/:dashboardId`