<!-- Code generated by internal/app/tools/agenttooldocgen; DO NOT EDIT. -->

# catalog_get

Get the compact definition and type-specific metadata for one exact catalog ref. A dashboard/page location is required when a visual or filter is shared.

Machine-readable: [focused JSON](/docs/agent-tools/tools/catalog_get.json) · [complete manifest](/docs/agent-tools/manifest.json)

## Contract

| Property | Value |
| --- | --- |
| Required privilege | `VIEW_ITEM` |
| Effect | `read` |
| Operation | `manual` |
| Tags | `catalog`, `describe` |
| Defaults | `{}` |
| MCP annotations | read-only, idempotent, non-destructive, closed-world |

## Input schema

```json
{
  "additionalProperties": false,
  "properties": {
    "location": {
      "additionalProperties": false,
      "properties": {
        "dashboardId": {
          "minLength": 1,
          "type": "string"
        },
        "pageId": {
          "minLength": 1,
          "type": "string"
        }
      },
      "required": [
        "dashboardId",
        "pageId"
      ],
      "type": "object"
    },
    "ref": {
      "additionalProperties": false,
      "properties": {
        "id": {
          "minLength": 1,
          "type": "string"
        },
        "type": {
          "enum": [
            "workspace",
            "dashboard",
            "page",
            "visual",
            "filter",
            "semantic_model",
            "semantic_table",
            "field",
            "measure"
          ],
          "type": "string"
        },
        "workspaceId": {
          "minLength": 1,
          "type": "string"
        }
      },
      "required": [
        "id",
        "type",
        "workspaceId"
      ],
      "type": "object"
    }
  },
  "required": [
    "ref"
  ],
  "type": "object"
}
```

## Output schema

```json
{
  "additionalProperties": false,
  "properties": {
    "details": {
      "oneOf": [
        {
          "additionalProperties": false,
          "allOf": [
            {
              "properties": {
                "type": {
                  "type": "string"
                }
              },
              "required": [
                "type"
              ],
              "type": "object"
            }
          ],
          "properties": {
            "activeServingStateId": {
              "type": "string"
            },
            "type": {
              "enum": [
                "workspace"
              ],
              "type": "string"
            }
          },
          "required": [
            "activeServingStateId",
            "type"
          ],
          "type": "object"
        },
        {
          "additionalProperties": false,
          "allOf": [
            {
              "properties": {
                "type": {
                  "type": "string"
                }
              },
              "required": [
                "type"
              ],
              "type": "object"
            }
          ],
          "properties": {
            "filterCount": {
              "type": "integer"
            },
            "pageCount": {
              "type": "integer"
            },
            "semanticModelRef": {
              "additionalProperties": false,
              "properties": {
                "id": {
                  "minLength": 1,
                  "type": "string"
                },
                "type": {
                  "enum": [
                    "workspace",
                    "dashboard",
                    "page",
                    "visual",
                    "filter",
                    "semantic_model",
                    "semantic_table",
                    "field",
                    "measure"
                  ],
                  "type": "string"
                },
                "workspaceId": {
                  "minLength": 1,
                  "type": "string"
                }
              },
              "required": [
                "id",
                "type",
                "workspaceId"
              ],
              "type": "object"
            },
            "type": {
              "enum": [
                "dashboard"
              ],
              "type": "string"
            },
            "visualCount": {
              "type": "integer"
            }
          },
          "required": [
            "filterCount",
            "pageCount",
            "semanticModelRef",
            "type",
            "visualCount"
          ],
          "type": "object"
        },
        {
          "additionalProperties": false,
          "allOf": [
            {
              "properties": {
                "type": {
                  "type": "string"
                }
              },
              "required": [
                "type"
              ],
              "type": "object"
            }
          ],
          "properties": {
            "components": {
              "items": {
                "additionalProperties": false,
                "properties": {
                  "description": {
                    "type": "string"
                  },
                  "filterId": {
                    "type": "string"
                  },
                  "height": {
                    "type": "number"
                  },
                  "id": {
                    "type": "string"
                  },
                  "kind": {
                    "type": "string"
                  },
                  "placement": {
                    "additionalProperties": false,
                    "properties": {
                      "col": {
                        "type": "integer"
                      },
                      "colSpan": {
                        "type": "integer"
                      },
                      "height": {
                        "type": "number"
                      },
                      "row": {
                        "type": "integer"
                      },
                      "rowSpan": {
                        "type": "integer"
                      },
                      "width": {
                        "type": "number"
                      },
                      "x": {
                        "type": "number"
                      },
                      "y": {
                        "type": "number"
                      }
                    },
                    "type": "object"
                  },
                  "ref": {
                    "type": "string"
                  },
                  "title": {
                    "type": "string"
                  },
                  "visualId": {
                    "type": "string"
                  },
                  "width": {
                    "type": "number"
                  },
                  "x": {
                    "type": "number"
                  },
                  "y": {
                    "type": "number"
                  }
                },
                "required": [
                  "id",
                  "kind"
                ],
                "type": "object"
              },
              "type": "array"
            },
            "type": {
              "enum": [
                "page"
              ],
              "type": "string"
            }
          },
          "required": [
            "components",
            "type"
          ],
          "type": "object"
        },
        {
          "additionalProperties": false,
          "allOf": [
            {
              "properties": {
                "type": {
                  "type": "string"
                }
              },
              "required": [
                "type"
              ],
              "type": "object"
            }
          ],
          "properties": {
            "columns": {
              "items": {
                "additionalProperties": false,
                "properties": {
                  "format": {
                    "type": "string"
                  },
                  "key": {
                    "type": "string"
                  },
                  "label": {
                    "type": "string"
                  },
                  "role": {
                    "type": "string"
                  }
                },
                "required": [
                  "key",
                  "label"
                ],
                "type": "object"
              },
              "type": "array"
            },
            "placement": {
              "additionalProperties": false,
              "properties": {
                "col": {
                  "type": "integer"
                },
                "colSpan": {
                  "type": "integer"
                },
                "height": {
                  "type": "number"
                },
                "row": {
                  "type": "integer"
                },
                "rowSpan": {
                  "type": "integer"
                },
                "width": {
                  "type": "number"
                },
                "x": {
                  "type": "number"
                },
                "y": {
                  "type": "number"
                }
              },
              "type": "object"
            },
            "query": {
              "additionalProperties": {},
              "type": "object"
            },
            "renderer": {
              "type": "string"
            },
            "shape": {
              "type": "string"
            },
            "type": {
              "enum": [
                "visual"
              ],
              "type": "string"
            },
            "visualType": {
              "type": "string"
            }
          },
          "required": [
            "columns",
            "placement",
            "query",
            "renderer",
            "shape",
            "type",
            "visualType"
          ],
          "type": "object"
        },
        {
          "additionalProperties": false,
          "allOf": [
            {
              "properties": {
                "type": {
                  "type": "string"
                }
              },
              "required": [
                "type"
              ],
              "type": "object"
            }
          ],
          "properties": {
            "configuration": {
              "additionalProperties": {},
              "type": "object"
            },
            "field": {
              "type": "string"
            },
            "placement": {
              "additionalProperties": false,
              "properties": {
                "col": {
                  "type": "integer"
                },
                "colSpan": {
                  "type": "integer"
                },
                "height": {
                  "type": "number"
                },
                "row": {
                  "type": "integer"
                },
                "rowSpan": {
                  "type": "integer"
                },
                "width": {
                  "type": "number"
                },
                "x": {
                  "type": "number"
                },
                "y": {
                  "type": "number"
                }
              },
              "type": "object"
            },
            "type": {
              "enum": [
                "filter"
              ],
              "type": "string"
            }
          },
          "required": [
            "configuration",
            "field",
            "placement",
            "type"
          ],
          "type": "object"
        },
        {
          "additionalProperties": false,
          "allOf": [
            {
              "properties": {
                "type": {
                  "type": "string"
                }
              },
              "required": [
                "type"
              ],
              "type": "object"
            }
          ],
          "properties": {
            "atomicMeasureCount": {
              "type": "integer"
            },
            "conformedDimensionCount": {
              "type": "integer"
            },
            "dashboardCount": {
              "type": "integer"
            },
            "dashboardUsage": {
              "items": {
                "additionalProperties": false,
                "properties": {
                  "id": {
                    "minLength": 1,
                    "type": "string"
                  },
                  "type": {
                    "enum": [
                      "workspace",
                      "dashboard",
                      "page",
                      "visual",
                      "filter",
                      "semantic_model",
                      "semantic_table",
                      "field",
                      "measure"
                    ],
                    "type": "string"
                  },
                  "workspaceId": {
                    "minLength": 1,
                    "type": "string"
                  }
                },
                "required": [
                  "id",
                  "type",
                  "workspaceId"
                ],
                "type": "object"
              },
              "type": "array"
            },
            "factCount": {
              "type": "integer"
            },
            "fieldCount": {
              "type": "integer"
            },
            "metricCount": {
              "type": "integer"
            },
            "relationshipCount": {
              "type": "integer"
            },
            "relationships": {
              "items": {
                "additionalProperties": false,
                "properties": {
                  "active": {
                    "type": "boolean"
                  },
                  "cardinality": {
                    "type": "string"
                  },
                  "description": {
                    "type": "string"
                  },
                  "fromFieldRef": {
                    "additionalProperties": false,
                    "properties": {
                      "id": {
                        "minLength": 1,
                        "type": "string"
                      },
                      "type": {
                        "enum": [
                          "workspace",
                          "dashboard",
                          "page",
                          "visual",
                          "filter",
                          "semantic_model",
                          "semantic_table",
                          "field",
                          "measure"
                        ],
                        "type": "string"
                      },
                      "workspaceId": {
                        "minLength": 1,
                        "type": "string"
                      }
                    },
                    "required": [
                      "id",
                      "type",
                      "workspaceId"
                    ],
                    "type": "object"
                  },
                  "id": {
                    "type": "string"
                  },
                  "toFieldRef": {
                    "additionalProperties": false,
                    "properties": {
                      "id": {
                        "minLength": 1,
                        "type": "string"
                      },
                      "type": {
                        "enum": [
                          "workspace",
                          "dashboard",
                          "page",
                          "visual",
                          "filter",
                          "semantic_model",
                          "semantic_table",
                          "field",
                          "measure"
                        ],
                        "type": "string"
                      },
                      "workspaceId": {
                        "minLength": 1,
                        "type": "string"
                      }
                    },
                    "required": [
                      "id",
                      "type",
                      "workspaceId"
                    ],
                    "type": "object"
                  }
                },
                "required": [
                  "active",
                  "cardinality",
                  "description",
                  "fromFieldRef",
                  "id",
                  "toFieldRef"
                ],
                "type": "object"
              },
              "type": "array"
            },
            "semanticTableCount": {
              "type": "integer"
            },
            "type": {
              "enum": [
                "semantic_model"
              ],
              "type": "string"
            }
          },
          "required": [
            "atomicMeasureCount",
            "conformedDimensionCount",
            "dashboardCount",
            "dashboardUsage",
            "factCount",
            "fieldCount",
            "metricCount",
            "relationshipCount",
            "relationships",
            "semanticTableCount",
            "type"
          ],
          "type": "object"
        },
        {
          "additionalProperties": false,
          "allOf": [
            {
              "properties": {
                "type": {
                  "type": "string"
                }
              },
              "required": [
                "type"
              ],
              "type": "object"
            }
          ],
          "properties": {
            "fieldCount": {
              "type": "integer"
            },
            "grain": {
              "type": "string"
            },
            "keys": {
              "items": {
                "type": "string"
              },
              "type": "array"
            },
            "measureCount": {
              "type": "integer"
            },
            "primaryKey": {
              "type": "string"
            },
            "roles": {
              "items": {
                "enum": [
                  "fact",
                  "dimension"
                ],
                "type": "string"
              },
              "type": "array"
            },
            "source": {
              "type": "string"
            },
            "sources": {
              "items": {
                "type": "string"
              },
              "type": "array"
            },
            "type": {
              "enum": [
                "semantic_table"
              ],
              "type": "string"
            }
          },
          "required": [
            "fieldCount",
            "grain",
            "keys",
            "measureCount",
            "primaryKey",
            "roles",
            "source",
            "sources",
            "type"
          ],
          "type": "object"
        },
        {
          "additionalProperties": false,
          "allOf": [
            {
              "properties": {
                "type": {
                  "type": "string"
                }
              },
              "required": [
                "type"
              ],
              "type": "object"
            }
          ],
          "properties": {
            "bindings": {
              "items": {
                "additionalProperties": false,
                "properties": {
                  "fieldRef": {
                    "additionalProperties": false,
                    "properties": {
                      "id": {
                        "minLength": 1,
                        "type": "string"
                      },
                      "type": {
                        "enum": [
                          "workspace",
                          "dashboard",
                          "page",
                          "visual",
                          "filter",
                          "semantic_model",
                          "semantic_table",
                          "field",
                          "measure"
                        ],
                        "type": "string"
                      },
                      "workspaceId": {
                        "minLength": 1,
                        "type": "string"
                      }
                    },
                    "required": [
                      "id",
                      "type",
                      "workspaceId"
                    ],
                    "type": "object"
                  },
                  "relationshipPath": {
                    "items": {
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "semanticTableRef": {
                    "additionalProperties": false,
                    "properties": {
                      "id": {
                        "minLength": 1,
                        "type": "string"
                      },
                      "type": {
                        "enum": [
                          "workspace",
                          "dashboard",
                          "page",
                          "visual",
                          "filter",
                          "semantic_model",
                          "semantic_table",
                          "field",
                          "measure"
                        ],
                        "type": "string"
                      },
                      "workspaceId": {
                        "minLength": 1,
                        "type": "string"
                      }
                    },
                    "required": [
                      "id",
                      "type",
                      "workspaceId"
                    ],
                    "type": "object"
                  }
                },
                "required": [
                  "fieldRef",
                  "relationshipPath",
                  "semanticTableRef"
                ],
                "type": "object"
              },
              "type": "array"
            },
            "dataType": {
              "type": "string"
            },
            "expression": {
              "type": "string"
            },
            "grain": {
              "type": "string"
            },
            "kind": {
              "type": "string"
            },
            "label": {
              "type": "string"
            },
            "nullable": {
              "type": "boolean"
            },
            "primaryKey": {
              "type": "boolean"
            },
            "sourceField": {
              "type": "string"
            },
            "table": {
              "type": "string"
            },
            "timeGrains": {
              "items": {
                "type": "string"
              },
              "type": "array"
            },
            "type": {
              "enum": [
                "field"
              ],
              "type": "string"
            }
          },
          "required": [
            "dataType",
            "kind",
            "label",
            "type"
          ],
          "type": "object"
        },
        {
          "additionalProperties": false,
          "allOf": [
            {
              "properties": {
                "type": {
                  "type": "string"
                }
              },
              "required": [
                "type"
              ],
              "type": "object"
            }
          ],
          "properties": {
            "aggregation": {
              "type": "string"
            },
            "dependencyRefs": {
              "items": {
                "additionalProperties": false,
                "properties": {
                  "id": {
                    "minLength": 1,
                    "type": "string"
                  },
                  "type": {
                    "enum": [
                      "workspace",
                      "dashboard",
                      "page",
                      "visual",
                      "filter",
                      "semantic_model",
                      "semantic_table",
                      "field",
                      "measure"
                    ],
                    "type": "string"
                  },
                  "workspaceId": {
                    "minLength": 1,
                    "type": "string"
                  }
                },
                "required": [
                  "id",
                  "type",
                  "workspaceId"
                ],
                "type": "object"
              },
              "type": "array"
            },
            "empty": {
              "type": "string"
            },
            "expression": {
              "type": "string"
            },
            "factRef": {
              "additionalProperties": false,
              "properties": {
                "id": {
                  "minLength": 1,
                  "type": "string"
                },
                "type": {
                  "enum": [
                    "workspace",
                    "dashboard",
                    "page",
                    "visual",
                    "filter",
                    "semantic_model",
                    "semantic_table",
                    "field",
                    "measure"
                  ],
                  "type": "string"
                },
                "workspaceId": {
                  "minLength": 1,
                  "type": "string"
                }
              },
              "required": [
                "id",
                "type",
                "workspaceId"
              ],
              "type": "object"
            },
            "filters": {
              "items": {
                "additionalProperties": false,
                "properties": {
                  "fieldRef": {
                    "additionalProperties": false,
                    "properties": {
                      "id": {
                        "minLength": 1,
                        "type": "string"
                      },
                      "type": {
                        "enum": [
                          "workspace",
                          "dashboard",
                          "page",
                          "visual",
                          "filter",
                          "semantic_model",
                          "semantic_table",
                          "field",
                          "measure"
                        ],
                        "type": "string"
                      },
                      "workspaceId": {
                        "minLength": 1,
                        "type": "string"
                      }
                    },
                    "required": [
                      "id",
                      "type",
                      "workspaceId"
                    ],
                    "type": "object"
                  },
                  "operator": {
                    "type": "string"
                  },
                  "values": {
                    "items": {},
                    "type": "array"
                  }
                },
                "required": [
                  "fieldRef",
                  "operator",
                  "values"
                ],
                "type": "object"
              },
              "type": "array"
            },
            "format": {
              "type": "string"
            },
            "hidden": {
              "type": "boolean"
            },
            "input": {
              "additionalProperties": false,
              "properties": {
                "expression": {
                  "type": "string"
                },
                "fieldRef": {
                  "additionalProperties": false,
                  "properties": {
                    "id": {
                      "minLength": 1,
                      "type": "string"
                    },
                    "type": {
                      "enum": [
                        "workspace",
                        "dashboard",
                        "page",
                        "visual",
                        "filter",
                        "semantic_model",
                        "semantic_table",
                        "field",
                        "measure"
                      ],
                      "type": "string"
                    },
                    "workspaceId": {
                      "minLength": 1,
                      "type": "string"
                    }
                  },
                  "required": [
                    "id",
                    "type",
                    "workspaceId"
                  ],
                  "type": "object"
                }
              },
              "type": "object"
            },
            "kind": {
              "type": "string"
            },
            "label": {
              "type": "string"
            },
            "table": {
              "type": "string"
            },
            "type": {
              "enum": [
                "measure"
              ],
              "type": "string"
            },
            "unit": {
              "type": "string"
            }
          },
          "required": [
            "dependencyRefs",
            "format",
            "hidden",
            "kind",
            "label",
            "type",
            "unit"
          ],
          "type": "object"
        }
      ]
    },
    "item": {
      "additionalProperties": false,
      "properties": {
        "capabilities": {
          "items": {
            "enum": [
              "catalog_get",
              "catalog_list",
              "query_semantic_model",
              "query_dashboard_visual",
              "query_visual"
            ],
            "type": "string"
          },
          "type": "array"
        },
        "description": {
          "type": "string"
        },
        "hierarchy": {
          "items": {
            "additionalProperties": false,
            "properties": {
              "name": {
                "type": "string"
              },
              "ref": {
                "additionalProperties": false,
                "properties": {
                  "id": {
                    "minLength": 1,
                    "type": "string"
                  },
                  "type": {
                    "enum": [
                      "workspace",
                      "dashboard",
                      "page",
                      "visual",
                      "filter",
                      "semantic_model",
                      "semantic_table",
                      "field",
                      "measure"
                    ],
                    "type": "string"
                  },
                  "workspaceId": {
                    "minLength": 1,
                    "type": "string"
                  }
                },
                "required": [
                  "id",
                  "type",
                  "workspaceId"
                ],
                "type": "object"
              }
            },
            "required": [
              "name",
              "ref"
            ],
            "type": "object"
          },
          "type": "array"
        },
        "href": {
          "type": "string"
        },
        "locations": {
          "items": {
            "additionalProperties": false,
            "properties": {
              "dashboardId": {
                "minLength": 1,
                "type": "string"
              },
              "dashboardName": {
                "type": "string"
              },
              "href": {
                "type": "string"
              },
              "pageId": {
                "minLength": 1,
                "type": "string"
              },
              "pageName": {
                "type": "string"
              }
            },
            "required": [
              "dashboardId",
              "pageId"
            ],
            "type": "object"
          },
          "type": "array"
        },
        "name": {
          "type": "string"
        },
        "ref": {
          "additionalProperties": false,
          "properties": {
            "id": {
              "minLength": 1,
              "type": "string"
            },
            "type": {
              "enum": [
                "workspace",
                "dashboard",
                "page",
                "visual",
                "filter",
                "semantic_model",
                "semantic_table",
                "field",
                "measure"
              ],
              "type": "string"
            },
            "workspaceId": {
              "minLength": 1,
              "type": "string"
            }
          },
          "required": [
            "id",
            "type",
            "workspaceId"
          ],
          "type": "object"
        },
        "workspace": {
          "additionalProperties": false,
          "properties": {
            "name": {
              "type": "string"
            },
            "ref": {
              "additionalProperties": false,
              "properties": {
                "id": {
                  "minLength": 1,
                  "type": "string"
                },
                "type": {
                  "enum": [
                    "workspace",
                    "dashboard",
                    "page",
                    "visual",
                    "filter",
                    "semantic_model",
                    "semantic_table",
                    "field",
                    "measure"
                  ],
                  "type": "string"
                },
                "workspaceId": {
                  "minLength": 1,
                  "type": "string"
                }
              },
              "required": [
                "id",
                "type",
                "workspaceId"
              ],
              "type": "object"
            }
          },
          "required": [
            "name",
            "ref"
          ],
          "type": "object"
        }
      },
      "required": [
        "capabilities",
        "hierarchy",
        "name",
        "ref",
        "workspace"
      ],
      "type": "object"
    }
  },
  "required": [
    "details",
    "item"
  ],
  "type": "object"
}
```