get_grid_curl
Discover exact input fields required by a grid and get a ready-to-use curl command to run it, eliminating trial and error.
Instructions
Get a ready-to-use curl command and structured API contract for running a specific Grid. Call this BEFORE run_grid to discover the exact input fields required by the grid — no trial and error needed.
This endpoint returns the derived required inputs (traced from column dependencies), the full run URL, request body shape, and a copy-paste- ready curl command.
💡 Recommended workflow: 1. Call get_grid_curl to discover the exact input fields. 2. Call run_grid with the returned inputs shape and real values.
Args: grid_id: UUID of the grid. Found in the grid URL at app.bitscale.ai/grid/{gridId}, or from list_grids. output_columns: Optional comma-separated list of column key IDs to include in the run. When provided, required inputs are derived only from the dependencies of the specified columns. When omitted, inputs are derived from all runnable columns in the grid. Example: "col-uuid-1,col-uuid-2"
Returns: grid_id, grid_name, run_url, method, headers, request_body (with mode, inputs shape, and optional output_columns), output_columns array (id, name, type for each requested column), and a curl string ready to copy-paste into a terminal (replace YOUR_WORKSPACE_API_KEY).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| grid_id | Yes | ||
| output_columns | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |
Implementation Reference
- main.py:264-302 (handler)The get_grid_curl MCP tool handler. It accepts grid_id and optional output_columns, validates grid_id, builds query params, calls the BitScale API GET /grids/{grid_id}/curl endpoint via the _get helper, and returns the JSON response as a string.
def get_grid_curl( grid_id: str, output_columns: str = "", ) -> str: """ Get a ready-to-use curl command and structured API contract for running a specific Grid. Call this BEFORE run_grid to discover the exact input fields required by the grid — no trial and error needed. This endpoint returns the derived required inputs (traced from column dependencies), the full run URL, request body shape, and a copy-paste- ready curl command. 💡 Recommended workflow: 1. Call get_grid_curl to discover the exact input fields. 2. Call run_grid with the returned inputs shape and real values. Args: grid_id: UUID of the grid. Found in the grid URL at app.bitscale.ai/grid/{gridId}, or from list_grids. output_columns: Optional comma-separated list of column key IDs to include in the run. When provided, required inputs are derived only from the dependencies of the specified columns. When omitted, inputs are derived from all runnable columns in the grid. Example: "col-uuid-1,col-uuid-2" Returns: grid_id, grid_name, run_url, method, headers, request_body (with mode, inputs shape, and optional output_columns), output_columns array (id, name, type for each requested column), and a curl string ready to copy-paste into a terminal (replace YOUR_WORKSPACE_API_KEY). """ if not grid_id: raise ValueError("grid_id must not be empty") params: dict = {} if output_columns: params["output_columns"] = output_columns data = _get(f"/grids/{grid_id}/curl", params=params if params else None) return json.dumps(data, indent=2) - main.py:263-264 (registration)The tool is registered as an MCP tool using the @mcp.tool() decorator on the get_grid_curl function.
@mcp.tool() def get_grid_curl( - main.py:47-53 (helper)The _get helper function used by get_grid_curl to perform authenticated GET requests against the BitScale API.
def _get(path: str, params: dict | None = None, timeout: int = 30) -> dict: """Perform an authenticated GET request against the BitScale API.""" url = f"{BITSCALE_API_BASE}{path}" with httpx.Client(timeout=timeout) as client: response = client.get(url, headers=_headers(), params=params) response.raise_for_status() return response.json()