Skip to main content
Glama
jupiterbak

AYX-MCP-Wrapper

by jupiterbak

get_workflow_jobs

Retrieve all jobs linked to a specific workflow in Alteryx Server to monitor execution status and manage task progress.

Instructions

Get all jobs associated with a workflow

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
workflow_idYes

Implementation Reference

  • Core implementation of get_workflow_jobs: retrieves the workflow, checks existence, calls the Alteryx API to get jobs, and formats the response.
    def get_workflow_jobs(self, workflow_id: str):
        """Get the list of jobs for an existing workflow"""
        try:
            workflow = self.workflows_api.workflows_get_workflow(workflow_id)
            if not workflow:
                return "Error: Workflow not found"
            api_response = self.workflows_api.workflows_get_jobs_for_workflow(workflow_id)
            return pprint.pformat(api_response)
        except ApiException as e:
            return f"Error: {e}"
  • MCP tool registration using @app.tool() decorator; thin wrapper delegating to the tools instance method.
    @self.app.tool()
    def get_workflow_jobs(workflow_id: str):
        """Get all jobs associated with a workflow"""
        return self.tools.get_workflow_jobs(workflow_id)
Behavior2/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

No annotations are provided, so the description carries full burden. It mentions retrieving jobs but doesn't disclose behavioral traits like whether it returns all jobs at once or paginates, what format the output is in, or if there are permissions or rate limits. This is a significant gap for a tool with no annotation coverage.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is a single, efficient sentence that directly states the tool's function without unnecessary words. It's front-loaded with the core action, making it easy to parse quickly.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the complexity of a retrieval tool with no annotations, 0% schema coverage, and no output schema, the description is incomplete. It doesn't address output format, pagination, error handling, or how it fits into the broader context of job management, leaving the agent with insufficient information for reliable use.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 0%, so the description must compensate. It implies the 'workflow_id' parameter is needed to specify which workflow's jobs to retrieve, adding some meaning beyond the bare schema. However, it doesn't explain the parameter's format, constraints, or how to obtain it, leaving gaps in documentation.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the verb 'Get' and the resource 'all jobs associated with a workflow', making the purpose understandable. It distinguishes from siblings like 'get_job_by_id' by focusing on workflow-level retrieval, though it doesn't explicitly mention how it differs from other job-related tools like 'get_all_job_messages'.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

No guidance is provided on when to use this tool versus alternatives. For example, it doesn't specify if this should be used instead of 'get_job_by_id' for batch retrieval or how it relates to 'get_all_job_messages'. The description only states what it does, not when it's appropriate.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/jupiterbak/AYX-MCP-Wrapper'

If you have feedback or need assistance with the MCP directory API, please join our Discord server