get_job_by_id
Retrieve job details and status by providing the job ID, enabling efficient tracking and management of workflows in the Alteryx ecosystem via the AYX-MCP-Wrapper server.
Instructions
Retrieve details about an existing job and its current state
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| job_id | Yes |
Implementation Reference
- src/tools.py:510-516 (handler)Actual handler implementation that calls the Alteryx API to retrieve job details by ID and formats the response.def get_job_by_id(self, job_id: str): """Retrieve details about an existing job and its current state. Only app workflows can be used.""" try: api_response = self.jobs_api.jobs_get_job_v3(job_id) return pprint.pformat(api_response) except ApiException as e: return f"Error: {e}"
- src/mcp_server.py:292-295 (registration)MCP tool registration decorator and wrapper function that delegates to the tools class method.@self.app.tool() def get_job_by_id(job_id: str): """Retrieve details about an existing job and its current state""" return self.tools.get_job_by_id(job_id)
- src/mcp_server.py:292-295 (handler)MCP FastMCP tool handler registration and simple delegation to core implementation.@self.app.tool() def get_job_by_id(job_id: str): """Retrieve details about an existing job and its current state""" return self.tools.get_job_by_id(job_id)