update_script_include
Modify an existing ServiceNow script include by updating its code, description, API name, access settings, or activation status to maintain custom business logic.
Instructions
Update an existing script include in ServiceNow
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| access | No | Access level of the script include | |
| active | No | Whether the script include is active | |
| api_name | No | API name of the script include | |
| client_callable | No | Whether the script include is client callable | |
| description | No | Description of the script include | |
| script | No | Script content | |
| script_include_id | Yes | Script include ID or name |
Implementation Reference
- The main handler function that implements the update_script_include tool. It fetches the existing script include, constructs the update payload from optional parameters, and performs a PATCH request to the ServiceNow API endpoint.def update_script_include( config: ServerConfig, auth_manager: AuthManager, params: UpdateScriptIncludeParams, ) -> ScriptIncludeResponse: """Update an existing script include in ServiceNow. Args: config: The server configuration. auth_manager: The authentication manager. params: The parameters for the request. Returns: A response indicating the result of the operation. """ # First, get the script include to update get_params = GetScriptIncludeParams(script_include_id=params.script_include_id) get_result = get_script_include(config, auth_manager, get_params) if not get_result["success"]: return ScriptIncludeResponse( success=False, message=get_result["message"], ) script_include = get_result["script_include"] sys_id = script_include["sys_id"] # Build the URL url = f"{config.instance_url}/api/now/table/sys_script_include/{sys_id}" # Build the request body body = {} if params.script is not None: body["script"] = params.script if params.description is not None: body["description"] = params.description if params.api_name is not None: body["api_name"] = params.api_name if params.client_callable is not None: body["client_callable"] = str(params.client_callable).lower() if params.active is not None: body["active"] = str(params.active).lower() if params.access is not None: body["access"] = params.access # If no fields to update, return success if not body: return ScriptIncludeResponse( success=True, message=f"No changes to update for script include: {script_include['name']}", script_include_id=sys_id, script_include_name=script_include["name"], ) # Make the request headers = auth_manager.get_headers() try: response = requests.patch( url, json=body, headers=headers, timeout=30, ) response.raise_for_status() # Parse the response data = response.json() if "result" not in data: return ScriptIncludeResponse( success=False, message=f"Failed to update script include: {script_include['name']}", ) result = data["result"] return ScriptIncludeResponse( success=True, message=f"Updated script include: {result.get('name')}", script_include_id=result.get("sys_id"), script_include_name=result.get("name"), ) except Exception as e: logger.error(f"Error updating script include: {e}") return ScriptIncludeResponse( success=False, message=f"Error updating script include: {str(e)}", )
- Pydantic model defining the input parameters for the update_script_include tool, including the script include identifier and optional fields to update.class UpdateScriptIncludeParams(BaseModel): """Parameters for updating a script include.""" script_include_id: str = Field(..., description="Script include ID or name") script: Optional[str] = Field(None, description="Script content") description: Optional[str] = Field(None, description="Description of the script include") api_name: Optional[str] = Field(None, description="API name of the script include") client_callable: Optional[bool] = Field(None, description="Whether the script include is client callable") active: Optional[bool] = Field(None, description="Whether the script include is active") access: Optional[str] = Field(None, description="Access level of the script include")
- src/servicenow_mcp/utils/tool_utils.py:692-698 (registration)Registration of the update_script_include tool in the central tool_definitions dictionary, mapping the tool name to its handler, params schema, return type, description, and serialization method."update_script_include": ( update_script_include_tool, UpdateScriptIncludeParams, ScriptIncludeResponse, # Expects Pydantic model "Update an existing script include in ServiceNow", "raw_pydantic", # Tool returns Pydantic model ),
- src/servicenow_mcp/utils/tool_utils.py:199-201 (registration)Import and aliasing of the update_script_include handler function as update_script_include_tool for use in tool registration.from servicenow_mcp.tools.script_include_tools import ( update_script_include as update_script_include_tool, )
- Pydantic model for the response returned by the update_script_include handler.class ScriptIncludeResponse(BaseModel): """Response from script include operations.""" success: bool = Field(..., description="Whether the operation was successful") message: str = Field(..., description="Message describing the result") script_include_id: Optional[str] = Field(None, description="ID of the affected script include") script_include_name: Optional[str] = Field(None, description="Name of the affected script include")