get_workflow_by_id
Retrieve detailed information about a specific workflow using its unique ID on the AYX-MCP-Wrapper server. Ideal for managing and analyzing workflow data within Alteryx environments.
Instructions
Get a workflow by its ID
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| workflow_id | Yes |
Implementation Reference
- src/tools.py:150-156 (handler)The core handler function in the Tools class that retrieves a specific workflow by its ID from the Alteryx server API, formats the response, and handles ApiException errors.def get_workflow_by_id(self, workflow_id: str): """Get a workflow by its ID""" try: api_response = self.workflows_api.workflows_get_workflow(workflow_id) return pprint.pformat(api_response) except ApiException as e: return f"Error: {e}"
- src/mcp_server.py:172-175 (registration)The MCP tool registration using @app.tool() decorator in MCPServer.register_tools(), which defines a wrapper that calls the underlying tools.get_workflow_by_id method.@self.app.tool() def get_workflow_by_id(workflow_id: str): """Get a workflow by its ID""" return self.tools.get_workflow_by_id(workflow_id)