- Home
- MCP servers
- AYX MCP Wrapper
AYX MCP Wrapper
- python
12
GitHub Stars
python
Language
4 months ago
First Indexed
3 weeks ago
Catalog Refreshed
Documentation & install
Readme and setup notes from the catalogue, plus a client-ready config you can copy for your MCP host.
Installation
Add the following to your MCP client configuration file.
Configuration
View docs{
"mcpServers": {
"jupiterbak-ayx-mcp-wrapper": {
"command": "uvx",
"args": [
"mcp-server-alteryx",
"--transport",
"stdio"
],
"env": {
"LOG_LEVEL": "INFO",
"ALTERYX_API_HOST": "https://your-server.com/webapi/",
"ALTERYX_CLIENT_ID": "your-client-id",
"ALTERYX_VERIFY_SSL": "1",
"ALTERYX_CLIENT_SECRET": "your-client-secret",
"ALTERYX_TEMP_DIRECTORY": "your-temp-directory"
}
}
}
}You can connect to an Alteryx Server through an MCP (Model Context Protocol) server wrapper, giving you a programmable interface to manage workflows, users, schedules, collections, and more from your AI assistants and MCP clients. This guide shows practical steps to install, configure, and run the AYX MCP Wrapper so you can perform common admin and workflow tasks efficiently.
How to use
You interact with the AYX MCP Wrapper by configuring an MCP client to run the MCP server locally via a transport channel. The main flow is: start the MCP server in stdio mode, connect your MCP client (such as Claude Desktop or Cursor IDE) to it, and issue operations to manage workflows, assets, users, schedules, and credentials. Use the provided commands to run the server and pass the necessary authentication details through environment variables or a configuration file.
How to install
# Prerequisites
- Python 3.10+
- Alteryx Server with API access
- OAuth2 Client ID and Client Secret
# Quick Start with uv (recommended)
# Install uv if you haven't already
curl -LsSf https://astral.sh/uv/install.sh | sh
# Install the MCP server
uv pip install mcp-server-alteryx
```} ,{
Additional setup and notes
Environment variables provide your authentication and server settings. You can set them in your shell or in a configuration file. Ensure the values reflect your Alteryx Server and OAuth2 credentials.
Configuration and startup options
The server supports different transport methods for connecting MCP clients. The typical setup uses stdio transport for local development, but you can also use other transports if your client supports them.
Troubleshooting tips
If you encounter authentication or connection issues, double-check that your ALTERYX_API_HOST, ALTERYX_CLIENT_ID, and ALTERYX_CLIENT_SECRET are correct and that SSL verification is enabled if your environment requires it.
Available tools
get_all_collections
Retrieve all accessible collections
get_collection_by_id
Get details for a specific collection by ID
create_collection
Create a new collection with a given name
update_collection_name_or_owner
Update collection name or owner details
add_workflow_to_collection
Add a workflow to a collection
remove_workflow_from_collection
Remove a workflow from a collection
add_schedule_to_collection
Associate a schedule with a collection
remove_schedule_from_collection
Disassociate a schedule from a collection
delete_collection
Delete a collection by ID
get_all_workflows
Retrieve all accessible workflows
get_workflow_by_id
Get details for a specific workflow by ID
update_workflow_name_or_comment
Update workflow name or comment
transfer_workflow
Transfer workflow ownership
get_workflow_jobs
Get jobs for a workflow
start_workflow_execution
Start a workflow execution and return a job ID
execute_workflow_with_monitoring
Execute a workflow and monitor completion
download_workflow_package_file
Download workflow package to a directory
get_workflow_xml
Extract workflow XML for analysis
get_all_users
Retrieve all accessible users
get_user_by_id
Get user details by ID
get_all_user_assets
Get all assets owned by a user
get_user_assets_by_type
Get assets of a specific type for a user
update_user_details
Update user information
transfer_all_assets
Transfer all assets from one user to another
deactivate_user
Deactivate a user account
reset_user_password
Reset a user's password
get_all_schedules
Retrieve all accessible schedules
get_schedule_by_id
Get details for a specific schedule
activate_schedule
Activate a schedule
deactivate_schedule
Deactivate a schedule
update_schedule_name_or_comment
Update schedule name or comment
change_schedule_owner
Change schedule owner
get_all_job_messages
Get messages for a specific job
get_job_by_id
Get job details by ID
get_job_output_data
Get output data files from a completed job
get_all_credentials
Retrieve all credentials
get_credential_by_id
Get credential details by ID
lookup_connection
Lookup DCM connection
get_connection_by_id
Get connection details