Skip to main content
Glama
jupiterbak

AYX-MCP-Wrapper

by jupiterbak
OverviewSchemaRelated ServersScoreDiscussions
Python
Hybrid

get_user_by_email

Retrieve user details from Alteryx Servers using an email address to manage user information and access.

Instructions

Get a user by their email

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
emailYes

Implementation Reference

  • src/tools.py:371-378 (handler)
    Core handler implementation in AYXMCPTools class that queries the Alteryx server users API to retrieve user details by email address.
    def get_user_by_email(self, email: str):
    """Get a user by their email"""
    try:
        api_response = self.users_api.users_get_users(email=email)
        return pprint.pformat(api_response)
    except ApiException as e:
        return f"Error: {e}"
  • src/mcp_server.py:241-244 (registration)
    MCP tool registration decorator and wrapper function that delegates to the AYXMCPTools instance's get_user_by_email method.
    @self.app.tool()
def get_user_by_email(email: str):
    """Get a user by their email"""
    return self.tools.get_user_by_email(email)

Tool Definition Quality

B3.1/5.0
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 only states the action ('Get a user') without mentioning permissions required, error handling (e.g., if email not found), rate limits, or what data is returned. This is inadequate for a tool with potential access control or data sensitivity implications.

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 zero wasted words. It is front-loaded with the core action and efficiently communicates the purpose without unnecessary elaboration, making it easy for an agent 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 lack of annotations and output schema, the description is incomplete. It doesn't explain what user data is returned (e.g., fields like ID, name, status), error conditions, or authentication needs. For a user lookup tool in a system with multiple user-related tools, more context is needed to ensure proper agent usage.

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?

The description adds meaningful context for the single parameter by specifying that 'email' is used to identify the user, which is valuable given 0% schema description coverage. However, it doesn't detail email format requirements or validation rules, leaving some ambiguity. With only one parameter, the baseline is high, but minor gaps prevent a perfect score.

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 resource ('a user'), specifying the lookup method ('by their email'). It distinguishes from siblings like get_user_by_id, get_user_by_name, and get_user_by_first_name by indicating the identifier type. However, it doesn't explicitly mention what user information is retrieved, which prevents a perfect score.

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_id or get_user_by_name. The description simply states what it does without context about prerequisites, limitations, or comparison to sibling tools, leaving the agent to infer usage scenarios.

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