remove_schedule_from_collection
Remove a scheduled workflow from an Alteryx collection by specifying both collection and schedule IDs. This tool helps manage automated workflow execution within collections.
Instructions
Remove a schedule from a collection by its ID
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| collection_id | Yes | ||
| schedule_id | Yes |
Implementation Reference
- src/tools.py:127-139 (handler)The core handler function that implements the tool logic: validates collection and schedule existence, calls the Alteryx collections API to remove the schedule, and returns the formatted API response.
def remove_schedule_from_collection(self, collection_id: str, schedule_id: str): """Remove a schedule from a collection by its ID""" try: collection = self.collections_api.collections_get_collection(collection_id) if not collection: return "Error: Collection not found" schedule = self.schedules_api.schedules_get_schedule(schedule_id) if not schedule: return "Error: Schedule not found" api_response = self.collections_api.collections_remove_schedule_from_collection(collection_id, schedule_id) return pprint.pformat(api_response) except ApiException as e: return f"Error: {e}" - src/mcp_server.py:161-164 (registration)MCP server tool registration decorator that exposes the handler as an MCP tool and delegates execution to the tools instance method.
@self.app.tool() def remove_schedule_from_collection(collection_id: str, schedule_id: str): """Remove a schedule from a collection by its ID""" return self.tools.remove_schedule_from_collection(collection_id, schedule_id) - src/mcp_server.py:48-48 (schema)Tool description in the system prompt defining the tool's purpose.
- remove_schedule_from_collection: Remove a schedule from a collection