Skip to main content

Model Context Protocol (MCP) server for Alteryx Analytics Cloud

Project description

OpenOne

Unofficial MCP Server & API Client for Alteryx Analytics Platform

Python 3.10+ License: MIT MCP Compatible

⚠️ DISCLAIMER: This is NOT an official implementation. This project is a personal initiative and is not affiliated with, endorsed by, or supported by any company.

Overview

OpenOne is an unofficial Model Context Protocol (MCP) server and Python API client for Alteryx Analytics Platform. It enables seamless integration between Claude and other MCP-compatible clients with your Alteryx Analytics Platform instance, providing programmatic access to schedules, datasets, plans and user management.

🚀 Quick Stats

  • 31 MCP Tools across 8 functional categories
  • Complete API Coverage for all core Alteryx APIs including legacy APIs
  • Production Ready with comprehensive error handling
  • Real-time Integration with Claude Desktop

Features

  • 🔗 MCP-Compatible Server - Direct integration with Claude and other MCP clients
  • 🐍 Python API Client - Full-featured client for Alteryx Analytics Platform
    • 📅 Schedule Management - Complete CRUD operations for workflow schedules
    • 🗂️ Plan Management - Create, run, and manage execution plans
    • 🏢 Workspace Management - Multi-workspace support and user administration
    • 📊 Dataset Management - Access imported and wrangled datasets
    • 🔌 Connection Management - Monitor and manage data connections
    • 📄 Publication Management - Handle published outputs and results
    • 👥 User Management - User profiles and permission management
    • 🌍 Multi-Region Support - Works with all regions worldwide
  • 🔄 Real-time Operations - Live status monitoring and execution tracking

Installation

Prerequisites

  • Python 3.10 or higher
  • Alteryx Analytics Cloud Platform account
  • OAuth2 credentials (Client ID, initial Access Token & Refresh Token)

Install Options

From GitHub (Recommended):

git clone https://github.com/jupiterbak/OpenOne.git
cd OpenOne
pip install .

Configuration

Environment Variables

Set up your OpenOne Analytics Platform credentials using environment variables:

# Required
export OPENONE_API_BASE_URL="https://api.eu1.alteryxcloud.com"
export OPENONE_TOKEN_ENDPOINT="https://pingauth-eu1.alteryxcloud.com/as"
export OPENONE_CLIENT_ID="your_client_id_here"
export OPENONE_PROJECT_ID="your_project_id_here"
export OPENONE_ACCESS_TOKEN="your_access_token_here"
export OPENONE_REFRESH_TOKEN="your_refresh_token"
# Optional
export OPENONE_PERSISTENT_FOLDER="~/.openone"
export OPENONE_VERIFY_SSL=1

Configuration File

Create a .env file in your project root:

OPENONE_API_BASE_URL=https://api.eu1.alteryxcloud.com
OPENONE_TOKEN_ENDPOINT=https://pingauth-eu1.alteryxcloud.com/as
OPENONE_CLIENT_ID=your_client_id_here
OPENONE_PROJECT_ID=your_project_id_here
OPENONE_ACCESS_TOKEN=your_access_token_here
OPENONE_REFRESH_TOKEN=your_refresh_token
OPENONE_PERSISTENT_FOLDER=~/.openone
OPENONE_VERIFY_SSL=1

MCP Server Setup - Claude Desktop Configuration

Add the following to your Claude configuration file:

{
  "mcpServers": {
    "openone": {
      "command": "python",
      "args": ["-m", "openone"],
      "env": {
        "OPENONE_API_BASE_URL": "https://api.eu1.alteryxcloud.com",
        "OPENONE_TOKEN_ENDPOINT": "https://pingauth-eu1.alteryxcloud.com/as",
        "OPENONE_CLIENT_ID": "your_client_id_here",
        "OPENONE_PROJECT_ID": "your_project_id_here",
        "OPENONE_ACCESS_TOKEN": "your_access_token_here",
        "OPENONE_REFRESH_TOKEN": "your_refresh_token",
        "OPENONE_PERSISTENT_FOLDER": "~/.openone"
      }
    }
  }
}

Alternative: Using a Configuration File

Instead of setting environment variables in the Claude config, you can create a .env file and reference it:

{
  "mcpServers": {
    "openone": {
      "command": "python",
      "args": ["-m", "openone"],
      "cwd": "/path/to/your/project",
      "env": {
        "OPENONE_CONFIG_FILE": "/path/to/your/.env"
      }
    }
  }
}

Testing the MCP Server

After configuration, restart Claude Desktop and test with these example queries:

Basic Operations:

  • "List all schedules in my OpenOne Analytics Platform instance"
  • "Show me my current workspace details and user count"
  • "Get a count of all my plans and datasets"

Schedule Management:

  • "Disable the schedule with ID 12345 and tell me why"
  • "Show me all enabled schedules and their next run times"
  • "Delete all schedules that haven't run in the last 30 days"

Data Operations:

  • "List all my datasets and show their connection status"
  • "Check if my database connections are working properly"
  • "Show me all wrangled datasets and their input sources"

Advanced Queries:

  • "Run plan abc123 and monitor its execution status"
  • "Show me all workspace admins and their permissions"
  • "List my publications and delete any older than 6 months"

API Client Usage

Basic Usage

import client
from client.rest import ApiException
from pprint import pprint

# Configure the client
configuration = client.Configuration()
api_instance = client.ScheduleApi(client.ApiClient(configuration))

try:
    # List all schedules
    schedules = api_instance.list_schedules()
    print(f"Found {len(schedules)} schedules")
    
    # Get a specific schedule
    schedule = api_instance.get_schedule(schedule_id="12345")
    pprint(schedule)
    
except ApiException as e:
    print(f"API Error: {e}")

MCP Available Tools

The MCP server provides comprehensive access to Alteryx Analytics Cloud through organized tool categories:

📅 Schedule Management Tools

Tool Description Parameters
list_schedules List all schedules in the workspace None
get_schedule Get details of a specific schedule schedule_id
update_schedule Update an existing schedule schedule_id, schedule_data
delete_schedule Delete a schedule by ID schedule_id
enable_schedule Enable a schedule by ID schedule_id
disable_schedule Disable a schedule by ID schedule_id
count_schedules Get the count of schedules in workspace None

🗂️ Plan Management Tools

Tool Description Parameters
list_plans List all plans in current workspace None
count_plans Get the count of plans in workspace None
get_plan Get a plan by ID plan_id
delete_plan Delete a plan by ID plan_id
get_plan_schedules Get schedules for a plan plan_id
run_plan Run a plan by ID plan_id

🏢 Workspace Management Tools

Tool Description Parameters
list_workspaces List all available workspaces None
get_current_workspace Get current workspace details None
get_workspace_configuration Get workspace configuration workspace_id
list_workspace_users List users in a workspace workspace_id
list_workspace_admins List admins in a workspace workspace_id

👥 User Management Tools

Tool Description Parameters
get_current_user Get current user information None
get_user Get user details by ID user_id

📊 Dataset Management Tools

Tool Description Parameters
list_datasets List all datasets None
get_dataset Get dataset details by ID dataset_id

🔌 Connection Management Tools

Tool Description Parameters
list_connections List all connections None
get_connection Get connection details by ID connection_id
get_connection_status Get connection status connection_id

📄 Publication Management Tools

Tool Description Parameters
list_publications List all publications for user None
get_publication Get publication details by ID publication_id
delete_publication Delete a publication by ID publication_id

🧹 Wrangled Dataset Management Tools

Tool Description Parameters
list_wrangled_datasets List all wrangled datasets None
get_wrangled_dataset Get wrangled dataset by ID wrangled_dataset_id
get_inputs_for_wrangled_dataset Get inputs for wrangled dataset wrangled_dataset_id

Example Usage with Claude

Here are some example queries you can use with Claude once the MCP server is configured:

Schedule Management:

  • "List all my schedules and show me which ones are currently enabled"
  • "Get details for schedule ID 12345 and tell me when it last ran"
  • "Disable the schedule with ID 67890 temporarily"
  • "Delete the schedule named 'old-workflow-schedule'"

Plan Management:

  • "Show me all my plans and their current status"
  • "Run the plan with ID abc123 and monitor its progress"
  • "Get the schedules associated with my data processing plan"

Workspace & User Management:

  • "List all workspaces I have access to"
  • "Show me all users in workspace ws-456 and their roles"
  • "Get my current user profile and permissions"

Data & Connections:

  • "List all my datasets and show their sizes"
  • "Check the status of my database connection conn-789"
  • "Show me all my data connections and which ones are active"

Publications:

  • "List all my published outputs and their creation dates"
  • "Get details about publication pub-321"

🔢 Tool Summary

Category Tool Count Key Operations
Schedule Management 7 tools List, Get, Update, Delete, Enable, Disable, Count
Plan Management 6 tools List, Get, Delete, Run, Get Schedules, Count
Workspace Management 5 tools List, Get Current, Get Config, List Users/Admins
User Management 2 tools Get Current User, Get User by ID
Dataset Management 2 tools List, Get by ID
Connection Management 3 tools List, Get, Check Status
Publication Management 3 tools List, Get, Delete
Wrangled Dataset Management 3 tools List, Get, Get Inputs
Total 31 tools Complete AACP integration

🤝 Contributing

We welcome contributions! Here's how you can help:

  1. Fork the repository
  2. Create a feature branch (git checkout -b feature/amazing-feature)
  3. Commit your changes (git commit -m 'Add amazing feature')
  4. Push to the branch (git push origin feature/amazing-feature)
  5. Open a Pull Request

Development Setup

git clone https://github.com/jupiterbak/OpenOne.git
cd OpenOne
pip install -e .[develop]
pytest  # Run tests

Code Style

  • Follow PEP 8 guidelines
  • Add type hints where appropriate
  • Include docstrings for all functions
  • Write tests for new features

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

Made with ❤️ for the Alteryx Community

GitHub stars GitHub forks

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

openone-0.1.1.tar.gz (654.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

openone-0.1.1-py3-none-any.whl (5.0 MB view details)

Uploaded Python 3

File details

Details for the file openone-0.1.1.tar.gz.

File metadata

  • Download URL: openone-0.1.1.tar.gz
  • Upload date:
  • Size: 654.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.6.9

File hashes

Hashes for openone-0.1.1.tar.gz
Algorithm Hash digest
SHA256 b5c3e13b8ceeba8c68b48313f4c65a8a8bcc9c79e02a8b2b22e589e8a7e6fd57
MD5 97249b5e3a5ba03cae26a8fb88f6fe12
BLAKE2b-256 f77d05736235f0cc67f7da72d580c729a8870c54a676b3adffb27a922844d51c

See more details on using hashes here.

File details

Details for the file openone-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: openone-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 5.0 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.6.9

File hashes

Hashes for openone-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 4bacbc826740b961c4e8306f28eadcf50c3b5f586d6c92220c190616fb4fa776
MD5 9748eb4e4b703a4c94ca4d89322e5dbe
BLAKE2b-256 17f75143b5d052ccd8e8acd72ddfa2d8531b05fb5a4963a2b5861002c462efd9

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page