Skip to main content
Glama
jupiterbak

AYX-MCP-Wrapper

by jupiterbak
OverviewSchemaRelated ServersScoreDiscussions
Python
Hybrid

get_schedule_by_id

Retrieve specific schedule details using a unique schedule ID from Alteryx Server for workflow automation management.

Instructions

Get a schedule by its ID

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
schedule_idYes

Implementation Reference

  • src/mcp_server.py:309-312 (handler)
    MCP server tool handler for 'get_schedule_by_id' that delegates execution to the tools instance method.
    @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 (helper)
    Core implementation of get_schedule_by_id that fetches the schedule from the Alteryx server API using schedules_api and formats the response with pprint.
    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}"

Tool Definition Quality

C2.9/5.0
Behavior2/5

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

No annotations are provided, so the description carries the full burden of behavioral disclosure. 'Get' implies a read operation, but it doesn't specify if it's safe (non-destructive), requires authentication, has rate limits, or what the output includes (e.g., schedule details, status). The description lacks critical behavioral traits beyond the basic action.

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, direct sentence with no wasted words, making it highly concise and front-loaded. It efficiently communicates the core purpose without unnecessary elaboration.

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 tool's simplicity (1 parameter, no annotations, no output schema), the description is incomplete. It doesn't cover what 'get' returns (e.g., schedule object, error handling), behavioral aspects like safety or permissions, or usage context relative to siblings. For a basic retrieval tool, more context is needed to be fully helpful.

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

Parameters4/5

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

With 0% schema description coverage and 1 parameter, the description adds value by implying the parameter's purpose ('by its ID'), but it doesn't explain the ID format (e.g., string type, expected pattern) or provide examples. Since there's only one parameter, the baseline is high, but more detail would improve clarity.

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

Purpose3/5

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

The description 'Get a schedule by its ID' clearly states the action (get) and resource (schedule), but it's vague about what 'get' entails (e.g., retrieve details, fetch metadata) and doesn't differentiate from siblings like 'get_all_schedules' or 'get_schedule_by_id' (implied by name only). It avoids tautology by not just restating the name, but lacks specificity.

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 is for retrieving a single schedule's details after listing schedules with 'get_all_schedules', or if it's preferred over other get-by-ID tools for schedules. The description offers no context or exclusions.

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