get_user_by_first_name
Retrieve user details from Alteryx Servers by specifying their first name to manage user information within workflows and collections.
Instructions
Get a user by their first name
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| first_name | Yes |
Implementation Reference
- src/tools.py:387-394 (handler)The core handler function in AYXMCPTools class that executes the tool logic by querying the Alteryx server Users API for users matching the given first name and returns formatted response or error.def get_user_by_first_name(self, first_name: str): """Get a user by their first name""" try: api_response = self.users_api.users_get_users(first_name=first_name) return pprint.pformat(api_response) except ApiException as e: return f"Error: {e}"
- src/mcp_server.py:251-254 (registration)The MCP tool registration using FastMCP's @app.tool() decorator. This wrapper function delegates the call to the underlying tools instance's get_user_by_first_name method.@self.app.tool() def get_user_by_first_name(first_name: str): """Get a user by their first name""" return self.tools.get_user_by_first_name(first_name)