opengov-mcp-server

by srobbin
MIT License
14
2

get_data

Retrieve datasets, metadata, and statistics from the Chicago Data Portal. Perform operations like data filtering, catalog searches, and site analytics using specified queries and parameters.

Instructions

[City of Chicago | Data Portal] Access data and metadata to learn more about the city and its underlying information.

Input Schema

NameRequiredDescriptionDefault
datasetIdNoDataset identifier required for the following operations: - For type=dataset-metadata: Get dataset details - For type=column-info: Get column information - For type=data-access: Specify which dataset to query (e.g., 6zsd-86xi)
domainNoOptional domain (hostname only, without protocol). Used with all operation types.
groupNoFor type=data-access only. Groups results for aggregate functions.
havingNoFor type=data-access only. Filters for grouped results, similar to where but for grouped data.
limitNoMaximum number of results to return: - For type=catalog: Limits dataset results - For type=data-access: Limits data records returned
offsetNoNumber of results to skip for pagination: - For type=catalog: Skips dataset results - For type=data-access: Skips data records for pagination
orderNoFor type=data-access only. Orders the results based on specified columns (e.g., "date DESC").
qNoFor type=data-access only. Full text search parameter for free-text searching across the dataset.
queryNoSearch or query string with different uses depending on operation type: - For type=catalog: Search query to filter datasets - For type=data-access: SoQL query string for complex data filtering
selectNoFor type=data-access only. Specifies which columns to return in the result set.
soqlQueryNoFor type=data-access only. Optional SoQL query string for filtering data. This is an alias for the query parameter and takes precedence if both are provided.
typeYesThe type of operation to perform: - catalog: List datasets with optional search - categories: List all dataset categories - tags: List all dataset tags - dataset-metadata: Get detailed metadata for a specific dataset - column-info: Get column details for a specific dataset - data-access: Access records from a dataset (with query support) - site-metrics: Get portal-wide statistics
whereNoFor type=data-access only. Filters the rows to be returned (e.g., "magnitude > 3.0").

Input Schema (JSON Schema)

{ "additionalProperties": false, "properties": { "datasetId": { "description": "Dataset identifier required for the following operations:\n- For type=dataset-metadata: Get dataset details\n- For type=column-info: Get column information\n- For type=data-access: Specify which dataset to query (e.g., 6zsd-86xi)", "type": "string" }, "domain": { "description": "Optional domain (hostname only, without protocol). Used with all operation types.", "type": "string" }, "group": { "description": "For type=data-access only. Groups results for aggregate functions.", "type": "string" }, "having": { "description": "For type=data-access only. Filters for grouped results, similar to where but for grouped data.", "type": "string" }, "limit": { "default": 10, "description": "Maximum number of results to return:\n- For type=catalog: Limits dataset results\n- For type=data-access: Limits data records returned", "type": "number" }, "offset": { "default": 0, "description": "Number of results to skip for pagination:\n- For type=catalog: Skips dataset results\n- For type=data-access: Skips data records for pagination", "type": "number" }, "order": { "description": "For type=data-access only. Orders the results based on specified columns (e.g., \"date DESC\").", "type": "string" }, "q": { "description": "For type=data-access only. Full text search parameter for free-text searching across the dataset.", "type": "string" }, "query": { "description": "Search or query string with different uses depending on operation type:\n- For type=catalog: Search query to filter datasets\n- For type=data-access: SoQL query string for complex data filtering", "type": "string" }, "select": { "description": "For type=data-access only. Specifies which columns to return in the result set.", "type": "string" }, "soqlQuery": { "description": "For type=data-access only. Optional SoQL query string for filtering data.\nThis is an alias for the query parameter and takes precedence if both are provided.", "type": "string" }, "type": { "description": "The type of operation to perform:\n- catalog: List datasets with optional search\n- categories: List all dataset categories\n- tags: List all dataset tags\n- dataset-metadata: Get detailed metadata for a specific dataset\n- column-info: Get column details for a specific dataset\n- data-access: Access records from a dataset (with query support)\n- site-metrics: Get portal-wide statistics", "enum": [ "catalog", "categories", "tags", "dataset-metadata", "column-info", "data-access", "site-metrics" ], "type": "string" }, "where": { "description": "For type=data-access only. Filters the rows to be returned (e.g., \"magnitude > 3.0\").", "type": "string" } }, "required": [ "type" ], "type": "object" }

You must be authenticated.

Other Tools from opengov-mcp-server

Related Tools

    ID: avzzx1se02