Skip to main content
Glama
javerthl

ServiceNow MCP Server

by javerthl

update_workflow_activity

Modify an existing workflow activity in ServiceNow by updating its name, description, or attributes to adapt business processes.

Instructions

Update an existing activity in a workflow

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
activity_idYesActivity ID or sys_id
attributesNoAdditional attributes for the activity
descriptionNoDescription of the activity
nameNoName of the activity

Implementation Reference

  • Main handler function for the update_workflow_activity tool. Handles input parameters, makes a PATCH request to ServiceNow's wf_activity table to update the activity.
    def update_workflow_activity(
        auth_manager: AuthManager,
        server_config: ServerConfig,
        params: Dict[str, Any],
    ) -> Dict[str, Any]:
        """
        Update an existing activity in a workflow.
        
        Args:
            auth_manager: Authentication manager
            server_config: Server configuration
            params: Parameters for updating a workflow activity
            
        Returns:
            Dict[str, Any]: Updated workflow activity details
        """
        # Unwrap parameters if needed
        params = _unwrap_params(params, UpdateWorkflowActivityParams)
        
        # Get the correct auth_manager and server_config
        try:
            auth_manager, server_config = _get_auth_and_config(auth_manager, server_config)
        except ValueError as e:
            logger.error(f"Error getting auth and config: {e}")
            return {"error": str(e)}
        
        activity_id = params.get("activity_id")
        if not activity_id:
            return {"error": "Activity ID is required"}
        
        # Prepare data for the API request
        data = {}
        
        if params.get("name"):
            data["name"] = params["name"]
        
        if params.get("description") is not None:
            data["description"] = params["description"]
        
        if params.get("attributes"):
            # Add any additional attributes
            data.update(params["attributes"])
        
        if not data:
            return {"error": "No update parameters provided"}
        
        # Make the API request
        try:
            headers = auth_manager.get_headers()
            url = f"{server_config.instance_url}/api/now/table/wf_activity/{activity_id}"
            
            response = requests.patch(url, headers=headers, json=data)
            response.raise_for_status()
            
            result = response.json()
            return {
                "activity": result.get("result", {}),
                "message": "Activity updated successfully",
            }
        except requests.RequestException as e:
            logger.error(f"Error updating workflow activity: {e}")
            return {"error": str(e)}
        except Exception as e:
            logger.error(f"Unexpected error updating workflow activity: {e}")
            return {"error": str(e)}
  • Pydantic model defining the input parameters for the update_workflow_activity tool, including activity_id (required), optional name, description, and attributes.
    class UpdateWorkflowActivityParams(BaseModel):
        """Parameters for updating a workflow activity."""
        
        activity_id: str = Field(..., description="Activity ID or sys_id")
        name: Optional[str] = Field(None, description="Name of the activity")
        description: Optional[str] = Field(None, description="Description of the activity")
        attributes: Optional[Dict[str, Any]] = Field(None, description="Additional attributes for the activity")
  • Tool registration in the central tool_definitions dictionary. Maps the tool name to its handler (aliased import), schema, return type hint, description, and serialization method for MCP server integration.
    "update_workflow_activity": (
        update_workflow_activity_tool,
        UpdateWorkflowActivityParams,
        str,  # Expects JSON string
        "Update an existing activity in a workflow",
        "json_dict",  # Tool returns Pydantic model
    ),
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. 'Update an existing activity' implies a mutation operation, but the description doesn't specify required permissions, whether changes are reversible, what happens to unspecified attributes, 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 that states the core purpose without unnecessary words. It's appropriately sized for a straightforward update operation and front-loads the essential information.

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 no annotations and no output schema, the description is insufficient. It doesn't explain what constitutes a valid update, potential side effects, error responses, or relationship to sibling tools like 'get_workflow_activities'. The agent lacks critical context for safe and effective use.

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?

Schema description coverage is 100%, so the schema already documents all four parameters (activity_id, attributes, description, name) with their types and constraints. The description adds no additional parameter semantics beyond what's in the schema, maintaining the baseline score of 3 for high schema coverage.

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 ('Update') and resource ('an existing activity in a workflow'), making the purpose immediately understandable. It distinguishes this from sibling tools like 'add_workflow_activity' (creation) and 'delete_workflow_activity' (deletion), though it doesn't explicitly mention these alternatives in the description text itself.

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 'add_workflow_activity' or 'delete_workflow_activity'. It doesn't mention prerequisites (e.g., needing an existing activity), error conditions, or typical use cases. The agent must infer usage from the tool name and sibling list alone.

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/javerthl/servicenow-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server