get_schedule_by_id
Retrieve specific schedule details by providing its unique ID using this function within the AYX-MCP-Wrapper server, enabling efficient schedule management in Alteryx.
Instructions
Get a schedule by its ID
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| schedule_id | Yes |
Implementation Reference
- src/mcp_server.py:309-312 (registration)Registration of the MCP tool 'get_schedule_by_id'. This is the handler function decorated with @app.tool() that delegates to the underlying tools implementation.@self.app.tool() def get_schedule_by_id(schedule_id: str): """Get a schedule by its ID""" return self.tools.get_schedule_by_id(schedule_id)
- src/tools.py:597-603 (handler)Core implementation of get_schedule_by_id. Retrieves the schedule using the Alteryx SchedulesApi and returns a pretty-formatted response or error.def get_schedule_by_id(self, schedule_id: str): """Get a schedule by its ID""" try: api_response = self.schedules_api.schedules_get_schedule(schedule_id) return pprint.pformat(api_response) except ApiException as e: return f"Error: {e}"