Skip to main content
Glama
jupiterbak

AYX-MCP-Wrapper

by jupiterbak

get_user_by_id

Retrieve user details from Alteryx Servers by specifying a unique user ID to access account information and permissions.

Instructions

Get a user by their ID

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
user_idYes

Implementation Reference

  • Core implementation of get_user_by_id tool: calls Alteryx Users API to retrieve user details by ID and formats the response with error handling.
    def get_user_by_id(self, user_id: str):
        """Get a user by their ID"""
        try:
            api_response = self.users_api.users_get_user(user_id)
            return pprint.pformat(api_response)
        except ApiException as e:
            return f"Error: {e}"
  • MCP tool registration using @app.tool() decorator with a wrapper that delegates to AYXMCPTools.get_user_by_id.
    @self.app.tool()
    def get_user_by_id(user_id: str):
        """Get a user by their ID"""
        return self.tools.get_user_by_id(user_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 states the tool retrieves user data but doesn't disclose behavioral traits like required permissions, rate limits, error handling, or what data is returned. This leaves significant gaps for a read operation with no output schema.

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 with no wasted words. It front-loads the core purpose ('Get a user') and specifies the method ('by their ID'), making it easy to understand 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?

For a tool with no annotations, no output schema, and low schema coverage, the description is incomplete. It lacks details on return values, error cases, or behavioral context, making it inadequate for full agent understanding despite its conciseness.

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 description mentions 'by their ID', which aligns with the single parameter 'user_id' in the schema. However, with 0% schema description coverage, it doesn't add details like ID format or constraints. The baseline is 3 since the schema covers the parameter structure, but the description provides minimal extra meaning.

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 action ('Get') and target resource ('a user'), specifying the lookup method ('by their ID'). It distinguishes from siblings like get_user_by_email or get_user_by_name by explicitly mentioning the ID parameter, though it doesn't explicitly contrast them.

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 like get_user_by_email or get_user_by_name. The description lacks context about prerequisites, such as needing a user ID, or any exclusions or complementary tools.

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