Skip to main content
Glama
jupiterbak

AYX-MCP-Wrapper

by jupiterbak

get_collection_by_id

Retrieve a specific collection from Alteryx Servers using its unique identifier to access workflow groups and related resources.

Instructions

Get a collection by its ID

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
collection_idYes

Implementation Reference

  • The core handler function in AYXMCPTools class that retrieves a specific collection from the Alteryx server API using the collections_get_collection method and formats the response.
    def get_collection_by_id(self, collection_id: str):
        """Get a collection by its ID"""
        try:
            api_response = self.collections_api.collections_get_collection(collection_id)
            return pprint.pformat(api_response)
        except ApiException as e:
            return f"Error: {e}"
  • MCP tool registration using @app.tool() decorator in MCPAlteryxServer class, providing a thin wrapper that delegates to the tools instance's get_collection_by_id method.
    def get_collection_by_id(collection_id: str):
        """Get a collection by its ID"""
        return self.tools.get_collection_by_id(collection_id)
Behavior2/5

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

With no annotations provided, the description carries the full burden of behavioral disclosure. It states the action ('Get') but does not reveal any behavioral traits such as whether it's a read-only operation, error handling for invalid IDs, authentication requirements, rate limits, or response format. This leaves significant gaps for an agent to understand how the tool behaves beyond its basic purpose.

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 action without unnecessary elaboration, which is appropriate for a simple retrieval tool.

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 output schema, no annotations), the description is incomplete. It lacks details on behavioral aspects, parameter semantics, and usage context, which are crucial for an agent to invoke it correctly. While concise, it does not provide enough information to fully understand the tool's operation in the broader system with many sibling tools.

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, so the schema provides no semantic details. The description adds minimal value by implying that 'collection_id' is used to identify the collection, but it does not explain the ID format, constraints, or examples. This meets the baseline of 3 as it compensates slightly for the low schema coverage, 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 collection by its ID' clearly states the verb ('Get') and resource ('collection'), making the purpose understandable. However, it lacks specificity about what 'Get' entails (e.g., retrieve metadata, full details) and does not differentiate from sibling tools like 'get_all_collections' or 'get_workflow_by_id', which follow similar patterns for other resources.

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. It does not mention prerequisites (e.g., needing a valid collection ID), exclusions, or comparisons to siblings like 'get_all_collections' for listing or other 'get_*_by_id' tools for different resources. The description assumes context without explicit instructions.

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