Skip to main content
Glama
jupiterbak

AYX-MCP-Wrapper

by jupiterbak

update_user_details

Modify user information in Alteryx servers by updating first name, last name, and email for existing users identified by their ID.

Instructions

Update details of an existing user by their ID

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
user_idYes
first_nameYes
last_nameYes
emailYes

Implementation Reference

  • Core handler function that implements the logic for updating user details by fetching current user info, constructing an UpdateUserContract with optional new values for first_name, last_name, email, and calling the Alteryx server API to perform the update.
    def update_user_details(self, user_id: str, first_name: str, last_name: str, email: str):
        """Update details of an existing user by their ID. Can be used to update any of the user's details."""
        try:
            user_details = self.users_api.users_get_user(user_id)
            
            if not user_details:
                return "Error: User not found"
            contract = server_client.UpdateUserContract(
                id=user_details.id,
                first_name=first_name if first_name else user_details.first_name,
                last_name=last_name if last_name else user_details.last_name,
                email=email if email else user_details.email,
                role=user_details.role,
                default_worker_tag=user_details.default_worker_tag,
                can_schedule_jobs=user_details.can_schedule_jobs,
                can_prioritize_jobs=user_details.can_prioritize_jobs,
                can_assign_jobs=user_details.can_assign_jobs,
                can_create_collections=user_details.can_create_collections,
                is_api_enabled=user_details.is_api_enabled,
                default_credential_id=user_details.default_credential_id,
                is_account_locked=user_details.is_account_locked,
                is_active=user_details.is_active,
                is_validated=user_details.is_validated,
                time_zone=user_details.time_zone,
                language=user_details.language,
                can_create_and_update_dcm=user_details.can_create_and_update_dcm,
                can_share_for_execution_dcm=user_details.can_share_for_execution_dcm,
                can_share_for_collaboration_dcm=user_details.can_share_for_collaboration_dcm,
                can_manage_generic_vaults_dcm=user_details.can_manage_generic_vaults_dcm,
            )
            api_response = self.users_api.users_update_user(user_id, contract)
            return pprint.pformat(api_response)
        except ApiException as e:
            return f"Error: {e}"
  • MCP tool registration for update_user_details in the register_tools method, decorated with @self.app.tool() and delegating execution to the underlying tools.update_user_details method.
    def get_user_assets_by_type(user_id: str, asset_type: str):
        """Get user assets by type"""
        return self.tools.get_user_assets_by_type(user_id, asset_type)
    
    @self.app.tool()
    def update_user_details(user_id: str, first_name: str, last_name: str, email: str):
        """Update details of an existing user by their ID"""
        return self.tools.update_user_details(user_id, first_name, last_name, email)
  • Documentation listing in the system prompt describing the update_user_details tool.
    - get_all_users: Get all users
    - get_user_by_id: Get a specific user
    - get_user_by_email: Get user by email
    - get_user_by_name: Get user by name
    - get_user_by_first_name: Get user by first name
    - get_all_user_assets: Get all user assets
    - get_user_assets_by_type: Get user assets by type
    - update_user_details: Update user details
    - transfer_all_assets: Transfer all user assets
    - deactivate_user: Deactivate a user
    - reset_user_password: Reset user password
Behavior2/5

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

With no annotations provided, the description carries full burden for behavioral disclosure. It states this is an update operation (implying mutation) but doesn't disclose permission requirements, whether changes are reversible, what happens to unspecified fields, rate limits, or response format. For a mutation tool with zero annotation coverage, this leaves significant behavioral gaps.

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 zero wasted words. It's appropriately sized for a basic tool description and front-loads the core purpose immediately.

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 mutation tool with 4 required parameters, 0% schema description coverage, no annotations, and no output schema, the description is insufficiently complete. It should explain what fields are updatable, permission requirements, whether all fields must be provided, and what the response contains to be adequately helpful.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters2/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 0%, so the description must compensate for all 4 parameters. The description only mentions 'ID' (mapping to user_id) but doesn't explain what fields can be updated (first_name, last_name, email) or their semantics. It adds minimal value beyond what's inferable from parameter names, failing to adequately compensate for the coverage gap.

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 ('Update details') and target resource ('existing user by their ID'), which provides a specific verb+resource combination. However, it doesn't differentiate from sibling tools like 'update_collection_name_or_owner' or 'update_schedule_name_or_comment' beyond the user focus, so it doesn't fully distinguish from all alternatives.

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 like 'deactivate_user', 'reset_user_password', or other update tools. It mentions 'existing user' which implies a prerequisite, but offers no explicit when/when-not instructions or named alternatives for different user management 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