Skip to main content
Glama
jupiterbak

AYX-MCP-Wrapper

by jupiterbak

get_job_by_id

Retrieve details and current state of an existing job in Alteryx Servers by providing the job ID.

Instructions

Retrieve details about an existing job and its current state

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
job_idYes

Implementation Reference

  • MCP tool registration for get_job_by_id, decorated with @self.app.tool() and delegates to the tools class method.
    @self.app.tool()
    def get_job_by_id(job_id: str):
        """Retrieve details about an existing job and its current state"""
        return self.tools.get_job_by_id(job_id)
  • Core handler implementation that fetches the job details using the jobs_api and formats the output with error handling.
    def get_job_by_id(self, job_id: str):
        """Retrieve details about an existing job and its current state. Only app workflows can be used."""
        try:
            api_response = self.jobs_api.jobs_get_job_v3(job_id)
            return pprint.pformat(api_response)
        except ApiException as e:
            return f"Error: {e}"
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. It mentions retrieving details and state, implying a read-only operation, but doesn't disclose behavioral traits such as authentication needs, rate limits, error handling, or what specific details are included in the response. This leaves significant gaps 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 front-loads the core purpose without unnecessary words. It's appropriately sized for a simple retrieval tool, 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 no annotations, no output schema, and low schema coverage, the description is incomplete. It doesn't explain what details are retrieved, the response format, or any behavioral context, which is inadequate for a tool that likely returns complex job state information.

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?

The input schema has 1 parameter with 0% description coverage, and the tool description doesn't add any parameter-specific information beyond implying 'job_id' is needed. Since schema coverage is low, the description fails to compensate by explaining the parameter's format or constraints, but with only one parameter, the baseline is moderate.

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 'retrieve' and the resource 'details about an existing job and its current state', making the purpose specific. However, it doesn't explicitly distinguish this tool from sibling tools like 'get_workflow_jobs' or 'get_job_output_data', which might also retrieve job-related information, so it misses full differentiation.

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?

The description provides no guidance on when to use this tool versus alternatives. With siblings like 'get_workflow_jobs' (likely for listing jobs) and 'get_job_output_data' (likely for output details), there's no indication of context, prerequisites, or exclusions for this specific retrieval tool.

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