create_script_include

Instructions

Implementation Reference

• src/servicenow_mcp/tools/script_include_tools.py:262-331 (handler)

  The handler function that implements the core logic for creating a script include by making a POST request to the ServiceNow sys_script_include table API endpoint.

  def create_script_include(
      config: ServerConfig,
      auth_manager: AuthManager,
      params: CreateScriptIncludeParams,
  ) -> ScriptIncludeResponse:
      """Create a new 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.
      """
      # Build the URL
      url = f"{config.instance_url}/api/now/table/sys_script_include"
      
      # Build the request body
      body = {
          "name": params.name,
          "script": params.script,
          "active": str(params.active).lower(),
          "client_callable": str(params.client_callable).lower(),
          "access": params.access,
      }
      
      if params.description:
          body["description"] = params.description
          
      if params.api_name:
          body["api_name"] = params.api_name
          
      # Make the request
      headers = auth_manager.get_headers()
      
      try:
          response = requests.post(
              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="Failed to create script include",
              )
              
          result = data["result"]
          
          return ScriptIncludeResponse(
              success=True,
              message=f"Created 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 creating script include: {e}")
          return ScriptIncludeResponse(
              success=False,
              message=f"Error creating script include: {str(e)}",
          )

• src/servicenow_mcp/tools/script_include_tools.py:35-45 (schema)

  Pydantic model defining the input parameters for the create_script_include tool.

  class CreateScriptIncludeParams(BaseModel):
      """Parameters for creating a script include."""
      
      name: str = Field(..., description="Name of the script include")
      script: str = Field(..., 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: bool = Field(False, description="Whether the script include is client callable")
      active: bool = Field(True, description="Whether the script include is active")
      access: str = Field("package_private", description="Access level of the script include")

• src/servicenow_mcp/utils/tool_utils.py:685-691 (registration)

  Registration of the create_script_include tool in the central tool definitions dictionary used by the MCP server, including the handler, schema, description, and serialization method.

  "create_script_include": (
      create_script_include_tool,
      CreateScriptIncludeParams,
      ScriptIncludeResponse,  # Expects Pydantic model
      "Create a new script include in ServiceNow",
      "raw_pydantic",  # Tool returns Pydantic model
  ),

• src/servicenow_mcp/tools/script_include_tools.py:65-72 (schema)

  Pydantic model for the response returned by the create_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")

• src/servicenow_mcp/tools/__init__.py:60-66 (registration)

  Re-export of the create_script_include function from script_include_tools.py in the tools package __init__.

  from servicenow_mcp.tools.script_include_tools import (
      create_script_include,
      delete_script_include,
      get_script_include,
      list_script_includes,
      update_script_include,
  )