run_hex_project
Execute a Hex project by providing its UUID and optional input parameters to generate results, with options to update published outputs.
Instructions
Run a Hex project.
Args:
project_id: The UUID of the Hex project to run
input_params: Optional input parameters for the project
update_published_results: Whether to update published results
Returns:
JSON string with run details
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| project_id | Yes | ||
| input_params | No | ||
| update_published_results | No |
Implementation Reference
- src/hex_mcp/server.py:209-229 (handler)The handler function for the 'run_hex_project' tool. It sends a POST request to the Hex API to initiate a project run with optional input parameters and configuration options. The function is decorated with @mcp.tool() for registration as an MCP tool.@mcp.tool() async def run_hex_project(project_id: str, input_params: dict = None, update_published_results: bool = False) -> str: """Run a Hex project. Args: project_id: The UUID of the Hex project to run input_params: Optional input parameters for the project update_published_results: Whether to update published results Returns: JSON string with run details """ run_config = { "inputParams": input_params or {}, "updatePublishedResults": update_published_results, "useCachedSqlResults": True, } result = await hex_request("POST", f"/projects/{project_id}/runs", json=run_config) return result