"""
ServiceNow MCP Server
This module provides the main implementation of the ServiceNow MCP server.
"""
import json
import logging
import os
from typing import Any, Dict, Union
from dotenv import load_dotenv
from mcp.server.fastmcp import FastMCP
from servicenow_mcp.auth.auth_manager import AuthManager
from servicenow_mcp.tools.catalog_optimization import (
OptimizationRecommendationsParams,
UpdateCatalogItemParams,
)
from servicenow_mcp.tools.catalog_optimization import (
get_optimization_recommendations as get_optimization_recommendations_tool,
)
from servicenow_mcp.tools.catalog_optimization import (
update_catalog_item as update_catalog_item_tool,
)
from servicenow_mcp.tools.catalog_tools import (
CreateCatalogCategoryParams,
GetCatalogItemParams,
ListCatalogCategoriesParams,
ListCatalogItemsParams,
MoveCatalogItemsParams,
UpdateCatalogCategoryParams,
)
from servicenow_mcp.tools.catalog_tools import (
create_catalog_category as create_catalog_category_tool,
)
from servicenow_mcp.tools.catalog_tools import (
get_catalog_item as get_catalog_item_tool,
)
from servicenow_mcp.tools.catalog_tools import (
list_catalog_categories as list_catalog_categories_tool,
)
from servicenow_mcp.tools.catalog_tools import (
list_catalog_items as list_catalog_items_tool,
)
from servicenow_mcp.tools.catalog_tools import (
move_catalog_items as move_catalog_items_tool,
)
from servicenow_mcp.tools.catalog_tools import (
update_catalog_category as update_catalog_category_tool,
)
from servicenow_mcp.tools.catalog_variables import (
CreateCatalogItemVariableParams,
ListCatalogItemVariablesParams,
UpdateCatalogItemVariableParams,
)
from servicenow_mcp.tools.catalog_variables import (
create_catalog_item_variable as create_catalog_item_variable_tool,
)
from servicenow_mcp.tools.catalog_variables import (
list_catalog_item_variables as list_catalog_item_variables_tool,
)
from servicenow_mcp.tools.catalog_variables import (
update_catalog_item_variable as update_catalog_item_variable_tool,
)
from servicenow_mcp.tools.change_tools import (
AddChangeTaskParams,
ApproveChangeParams,
CreateChangeRequestParams,
GetChangeRequestDetailsParams,
ListChangeRequestsParams,
RejectChangeParams,
SubmitChangeForApprovalParams,
UpdateChangeRequestParams,
)
from servicenow_mcp.tools.change_tools import (
add_change_task as add_change_task_tool,
)
from servicenow_mcp.tools.change_tools import (
approve_change as approve_change_tool,
)
from servicenow_mcp.tools.change_tools import (
create_change_request as create_change_request_tool,
)
from servicenow_mcp.tools.change_tools import (
get_change_request_details as get_change_request_details_tool,
)
from servicenow_mcp.tools.change_tools import (
list_change_requests as list_change_requests_tool,
)
from servicenow_mcp.tools.change_tools import (
reject_change as reject_change_tool,
)
from servicenow_mcp.tools.change_tools import (
submit_change_for_approval as submit_change_for_approval_tool,
)
from servicenow_mcp.tools.change_tools import (
update_change_request as update_change_request_tool,
)
from servicenow_mcp.tools.changeset_tools import (
AddFileToChangesetParams,
CommitChangesetParams,
CreateChangesetParams,
GetChangesetDetailsParams,
ListChangesetsParams,
PublishChangesetParams,
UpdateChangesetParams,
)
from servicenow_mcp.tools.changeset_tools import (
add_file_to_changeset as add_file_to_changeset_tool,
)
from servicenow_mcp.tools.changeset_tools import (
commit_changeset as commit_changeset_tool,
)
from servicenow_mcp.tools.changeset_tools import (
create_changeset as create_changeset_tool,
)
from servicenow_mcp.tools.changeset_tools import (
get_changeset_details as get_changeset_details_tool,
)
from servicenow_mcp.tools.changeset_tools import (
list_changesets as list_changesets_tool,
)
from servicenow_mcp.tools.changeset_tools import (
publish_changeset as publish_changeset_tool,
)
from servicenow_mcp.tools.changeset_tools import (
update_changeset as update_changeset_tool,
)
from servicenow_mcp.tools.incident_tools import (
AddCommentParams,
CreateIncidentParams,
ListIncidentsParams,
ResolveIncidentParams,
UpdateIncidentParams,
)
from servicenow_mcp.tools.incident_tools import (
add_comment as add_comment_tool,
)
from servicenow_mcp.tools.incident_tools import (
create_incident as create_incident_tool,
)
from servicenow_mcp.tools.incident_tools import (
list_incidents as list_incidents_tool,
)
from servicenow_mcp.tools.incident_tools import (
resolve_incident as resolve_incident_tool,
)
from servicenow_mcp.tools.incident_tools import (
update_incident as update_incident_tool,
)
from servicenow_mcp.tools.knowledge_base import (
ArticleResponse,
CategoryResponse,
CreateArticleParams,
CreateCategoryParams,
CreateKnowledgeBaseParams,
GetArticleParams,
KnowledgeBaseResponse,
ListArticlesParams,
ListCategoriesParams,
ListKnowledgeBasesParams,
PublishArticleParams,
UpdateArticleParams,
)
from servicenow_mcp.tools.knowledge_base import (
create_article as create_article_tool,
)
from servicenow_mcp.tools.knowledge_base import (
create_category as create_category_tool,
)
from servicenow_mcp.tools.knowledge_base import (
create_knowledge_base as create_knowledge_base_tool,
)
from servicenow_mcp.tools.knowledge_base import (
get_article as get_article_tool,
)
from servicenow_mcp.tools.knowledge_base import (
list_articles as list_articles_tool,
)
from servicenow_mcp.tools.knowledge_base import (
list_categories as list_categories_tool,
)
from servicenow_mcp.tools.knowledge_base import (
list_knowledge_bases as list_knowledge_bases_tool,
)
from servicenow_mcp.tools.knowledge_base import (
publish_article as publish_article_tool,
)
from servicenow_mcp.tools.knowledge_base import (
update_article as update_article_tool,
)
from servicenow_mcp.tools.script_include_tools import (
CreateScriptIncludeParams,
DeleteScriptIncludeParams,
GetScriptIncludeParams,
ListScriptIncludesParams,
ScriptIncludeResponse,
UpdateScriptIncludeParams,
)
from servicenow_mcp.tools.script_include_tools import (
create_script_include as create_script_include_tool,
)
from servicenow_mcp.tools.script_include_tools import (
delete_script_include as delete_script_include_tool,
)
from servicenow_mcp.tools.script_include_tools import (
get_script_include as get_script_include_tool,
)
from servicenow_mcp.tools.script_include_tools import (
list_script_includes as list_script_includes_tool,
)
from servicenow_mcp.tools.script_include_tools import (
update_script_include as update_script_include_tool,
)
from servicenow_mcp.tools.user_tools import (
AddGroupMembersParams,
CreateGroupParams,
CreateUserParams,
GetUserParams,
ListGroupsParams,
ListUsersParams,
RemoveGroupMembersParams,
UpdateGroupParams,
UpdateUserParams,
)
from servicenow_mcp.tools.user_tools import (
add_group_members as add_group_members_tool,
)
from servicenow_mcp.tools.user_tools import (
create_group as create_group_tool,
)
from servicenow_mcp.tools.user_tools import (
create_user as create_user_tool,
)
from servicenow_mcp.tools.user_tools import (
get_user as get_user_tool,
)
from servicenow_mcp.tools.user_tools import (
list_groups as list_groups_tool,
)
from servicenow_mcp.tools.user_tools import (
list_users as list_users_tool,
)
from servicenow_mcp.tools.user_tools import (
remove_group_members as remove_group_members_tool,
)
from servicenow_mcp.tools.user_tools import (
update_group as update_group_tool,
)
from servicenow_mcp.tools.user_tools import (
update_user as update_user_tool,
)
from servicenow_mcp.tools.workflow_tools import (
ActivateWorkflowParams,
AddWorkflowActivityParams,
CreateWorkflowParams,
DeactivateWorkflowParams,
DeleteWorkflowActivityParams,
GetWorkflowActivitiesParams,
GetWorkflowDetailsParams,
ListWorkflowsParams,
ListWorkflowVersionsParams,
ReorderWorkflowActivitiesParams,
UpdateWorkflowActivityParams,
UpdateWorkflowParams,
)
from servicenow_mcp.tools.workflow_tools import (
activate_workflow as activate_workflow_tool,
)
from servicenow_mcp.tools.workflow_tools import (
add_workflow_activity as add_workflow_activity_tool,
)
from servicenow_mcp.tools.workflow_tools import (
create_workflow as create_workflow_tool,
)
from servicenow_mcp.tools.workflow_tools import (
deactivate_workflow as deactivate_workflow_tool,
)
from servicenow_mcp.tools.workflow_tools import (
delete_workflow_activity as delete_workflow_activity_tool,
)
from servicenow_mcp.tools.workflow_tools import (
get_workflow_activities as get_workflow_activities_tool,
)
from servicenow_mcp.tools.workflow_tools import (
get_workflow_details as get_workflow_details_tool,
)
from servicenow_mcp.tools.workflow_tools import (
list_workflow_versions as list_workflow_versions_tool,
)
from servicenow_mcp.tools.workflow_tools import (
list_workflows as list_workflows_tool,
)
from servicenow_mcp.tools.workflow_tools import (
reorder_workflow_activities as reorder_workflow_activities_tool,
)
from servicenow_mcp.tools.workflow_tools import (
update_workflow as update_workflow_tool,
)
from servicenow_mcp.tools.workflow_tools import (
update_workflow_activity as update_workflow_activity_tool,
)
from servicenow_mcp.utils.config import AuthConfig, AuthType, BasicAuthConfig, ServerConfig
# Set up logging
logging.basicConfig(level=logging.INFO)
logger = logging.getLogger(__name__)
class ServiceNowMCP:
"""
ServiceNow MCP Server implementation.
This class provides a Model Context Protocol (MCP) server for ServiceNow,
allowing LLMs to interact with ServiceNow data and functionality.
"""
def __init__(self, config: Union[Dict, ServerConfig]):
"""
Initialize the ServiceNow MCP server.
Args:
config: Server configuration, either as a dictionary or ServerConfig object.
"""
if isinstance(config, dict):
self.config = ServerConfig(**config)
else:
self.config = config
self.auth_manager = AuthManager(self.config.auth)
self.mcp_server = FastMCP("ServiceNow", port=8080, host="localhost")
# Add name attribute for MCP CLI
self.name = "ServiceNow"
# Register resources and tools
self._register_tools()
def _register_tools(self):
"""Register all ServiceNow tools with the MCP server."""
# Register incident tools
@self.mcp_server.tool()
def create_incident(params: CreateIncidentParams) -> str:
"""Create a new incident in ServiceNow"""
return create_incident_tool(self.config, self.auth_manager, params)
@self.mcp_server.tool()
def update_incident(params: UpdateIncidentParams) -> str:
"""Update an existing incident in ServiceNow"""
return update_incident_tool(self.config, self.auth_manager, params)
@self.mcp_server.tool()
def add_comment(params: AddCommentParams) -> str:
"""Add a comment to an incident in ServiceNow"""
return add_comment_tool(self.config, self.auth_manager, params)
@self.mcp_server.tool()
def resolve_incident(params: ResolveIncidentParams) -> str:
"""Resolve an incident in ServiceNow"""
return resolve_incident_tool(self.config, self.auth_manager, params)
@self.mcp_server.tool()
def list_incidents(params: ListIncidentsParams) -> str:
"""List incidents from ServiceNow"""
return list_incidents_tool(self.config, self.auth_manager, params)
# Register catalog tools
@self.mcp_server.tool()
def list_catalog_items(params: ListCatalogItemsParams) -> str:
"""List service catalog items."""
return json.dumps(list_catalog_items_tool(self.config, self.auth_manager, params))
@self.mcp_server.tool()
def get_catalog_item(params: GetCatalogItemParams) -> str:
"""Get a specific service catalog item."""
return json.dumps(get_catalog_item_tool(self.config, self.auth_manager, params).dict())
@self.mcp_server.tool()
def list_catalog_categories(params: ListCatalogCategoriesParams) -> str:
"""List service catalog categories."""
return json.dumps(list_catalog_categories_tool(self.config, self.auth_manager, params))
@self.mcp_server.tool()
def create_catalog_category(params: CreateCatalogCategoryParams) -> str:
"""Create a new service catalog category."""
return json.dumps(
create_catalog_category_tool(self.config, self.auth_manager, params).dict()
)
@self.mcp_server.tool()
def update_catalog_category(params: UpdateCatalogCategoryParams) -> str:
"""Update an existing service catalog category."""
return json.dumps(
update_catalog_category_tool(self.config, self.auth_manager, params).dict()
)
@self.mcp_server.tool()
def move_catalog_items(params: MoveCatalogItemsParams) -> str:
"""Move catalog items to a different category."""
return json.dumps(
move_catalog_items_tool(self.config, self.auth_manager, params).dict()
)
@self.mcp_server.tool()
def get_optimization_recommendations(params: OptimizationRecommendationsParams) -> str:
"""Get optimization recommendations for the service catalog."""
return json.dumps(
get_optimization_recommendations_tool(self.config, self.auth_manager, params)
)
@self.mcp_server.tool()
def update_catalog_item(params: UpdateCatalogItemParams) -> str:
"""Update a service catalog item."""
return json.dumps(
update_catalog_item_tool(
self.config,
self.auth_manager,
params,
)
)
@self.mcp_server.tool()
def create_catalog_item_variable(params: CreateCatalogItemVariableParams) -> Dict[str, Any]:
"""Create a new catalog item variable"""
return create_catalog_item_variable_tool(
self.config,
self.auth_manager,
params,
).__dict__
@self.mcp_server.tool()
def list_catalog_item_variables(params: ListCatalogItemVariablesParams) -> Dict[str, Any]:
"""List catalog item variables"""
return list_catalog_item_variables_tool(
self.config,
self.auth_manager,
params,
).__dict__
@self.mcp_server.tool()
def update_catalog_item_variable(params: UpdateCatalogItemVariableParams) -> Dict[str, Any]:
"""Update a catalog item variable"""
return update_catalog_item_variable_tool(
self.config,
self.auth_manager,
params,
).__dict__
# Register change management tools
@self.mcp_server.tool()
def create_change_request(params: CreateChangeRequestParams) -> str:
"""Create a new change request in ServiceNow"""
return create_change_request_tool(self.config, self.auth_manager, params)
@self.mcp_server.tool()
def update_change_request(params: UpdateChangeRequestParams) -> str:
"""Update an existing change request in ServiceNow"""
return update_change_request_tool(self.config, self.auth_manager, params)
@self.mcp_server.tool()
def list_change_requests(params: ListChangeRequestsParams) -> str:
"""List change requests from ServiceNow"""
return list_change_requests_tool(self.config, self.auth_manager, params)
@self.mcp_server.tool()
def get_change_request_details(params: GetChangeRequestDetailsParams) -> str:
"""Get detailed information about a specific change request"""
return get_change_request_details_tool(self.config, self.auth_manager, params)
@self.mcp_server.tool()
def add_change_task(params: AddChangeTaskParams) -> str:
"""Add a task to a change request"""
return add_change_task_tool(self.config, self.auth_manager, params)
@self.mcp_server.tool()
def submit_change_for_approval(params: SubmitChangeForApprovalParams) -> str:
"""Submit a change request for approval"""
return submit_change_for_approval_tool(self.config, self.auth_manager, params)
@self.mcp_server.tool()
def approve_change(params: ApproveChangeParams) -> str:
"""Approve a change request"""
return approve_change_tool(self.config, self.auth_manager, params)
@self.mcp_server.tool()
def reject_change(params: RejectChangeParams) -> str:
"""Reject a change request"""
return reject_change_tool(self.config, self.auth_manager, params)
# Register workflow management tools
@self.mcp_server.tool()
def list_workflows(params: ListWorkflowsParams) -> str:
"""List workflows from ServiceNow"""
return list_workflows_tool(self.config, self.auth_manager, params)
@self.mcp_server.tool()
def get_workflow_details(params: GetWorkflowDetailsParams) -> str:
"""Get detailed information about a specific workflow"""
return get_workflow_details_tool(self.config, self.auth_manager, params)
@self.mcp_server.tool()
def list_workflow_versions(params: ListWorkflowVersionsParams) -> str:
"""List workflow versions from ServiceNow"""
return list_workflow_versions_tool(self.config, self.auth_manager, params)
@self.mcp_server.tool()
def get_workflow_activities(params: GetWorkflowActivitiesParams) -> str:
"""Get activities for a specific workflow"""
return get_workflow_activities_tool(self.config, self.auth_manager, params)
@self.mcp_server.tool()
def create_workflow(params: CreateWorkflowParams) -> str:
"""Create a new workflow in ServiceNow"""
return create_workflow_tool(self.config, self.auth_manager, params)
@self.mcp_server.tool()
def update_workflow(params: UpdateWorkflowParams) -> str:
"""Update an existing workflow in ServiceNow"""
return update_workflow_tool(self.config, self.auth_manager, params)
@self.mcp_server.tool()
def activate_workflow(params: ActivateWorkflowParams) -> str:
"""Activate a workflow in ServiceNow"""
return activate_workflow_tool(self.config, self.auth_manager, params)
@self.mcp_server.tool()
def deactivate_workflow(params: DeactivateWorkflowParams) -> str:
"""Deactivate a workflow in ServiceNow"""
return deactivate_workflow_tool(self.config, self.auth_manager, params)
@self.mcp_server.tool()
def add_workflow_activity(params: AddWorkflowActivityParams) -> str:
"""Add a new activity to a workflow in ServiceNow"""
return add_workflow_activity_tool(self.config, self.auth_manager, params)
@self.mcp_server.tool()
def update_workflow_activity(params: UpdateWorkflowActivityParams) -> str:
"""Update an existing activity in a workflow"""
return update_workflow_activity_tool(self.config, self.auth_manager, params)
@self.mcp_server.tool()
def delete_workflow_activity(params: DeleteWorkflowActivityParams) -> str:
"""Delete an activity from a workflow"""
return delete_workflow_activity_tool(self.config, self.auth_manager, params)
@self.mcp_server.tool()
def reorder_workflow_activities(params: ReorderWorkflowActivitiesParams) -> str:
"""Reorder activities in a workflow"""
return reorder_workflow_activities_tool(self.config, self.auth_manager, params)
# Register changeset management tools
@self.mcp_server.tool()
def list_changesets(params: ListChangesetsParams) -> str:
"""List changesets from ServiceNow"""
return list_changesets_tool(self.config, self.auth_manager, params)
@self.mcp_server.tool()
def get_changeset_details(params: GetChangesetDetailsParams) -> str:
"""Get detailed information about a specific changeset"""
return get_changeset_details_tool(self.config, self.auth_manager, params)
@self.mcp_server.tool()
def create_changeset(params: CreateChangesetParams) -> str:
"""Create a new changeset in ServiceNow"""
return create_changeset_tool(self.config, self.auth_manager, params)
@self.mcp_server.tool()
def update_changeset(params: UpdateChangesetParams) -> str:
"""Update an existing changeset in ServiceNow"""
return update_changeset_tool(self.config, self.auth_manager, params)
@self.mcp_server.tool()
def commit_changeset(params: CommitChangesetParams) -> str:
"""Commit a changeset in ServiceNow"""
return commit_changeset_tool(self.config, self.auth_manager, params)
@self.mcp_server.tool()
def publish_changeset(params: PublishChangesetParams) -> str:
"""Publish a changeset in ServiceNow"""
return publish_changeset_tool(self.config, self.auth_manager, params)
@self.mcp_server.tool()
def add_file_to_changeset(params: AddFileToChangesetParams) -> str:
"""Add a file to a changeset in ServiceNow"""
return add_file_to_changeset_tool(self.config, self.auth_manager, params)
# Register script include tools
@self.mcp_server.tool()
def list_script_includes(params: ListScriptIncludesParams) -> Dict[str, Any]:
"""List script includes from ServiceNow"""
return list_script_includes_tool(self.config, self.auth_manager, params)
@self.mcp_server.tool()
def get_script_include(params: GetScriptIncludeParams) -> Dict[str, Any]:
"""Get a specific script include from ServiceNow"""
return get_script_include_tool(self.config, self.auth_manager, params)
@self.mcp_server.tool()
def create_script_include(params: CreateScriptIncludeParams) -> ScriptIncludeResponse:
"""Create a new script include in ServiceNow"""
return create_script_include_tool(self.config, self.auth_manager, params)
@self.mcp_server.tool()
def update_script_include(params: UpdateScriptIncludeParams) -> ScriptIncludeResponse:
"""Update an existing script include in ServiceNow"""
return update_script_include_tool(self.config, self.auth_manager, params)
@self.mcp_server.tool()
def delete_script_include(params: DeleteScriptIncludeParams) -> str:
"""Delete a script include in ServiceNow"""
return json.dumps(
delete_script_include_tool(self.config, self.auth_manager, params).dict()
)
# Knowledge Base tools
@self.mcp_server.tool()
def create_knowledge_base(params: CreateKnowledgeBaseParams) -> str:
"""Create a new knowledge base in ServiceNow"""
return json.dumps(
create_knowledge_base_tool(self.config, self.auth_manager, params).dict()
)
@self.mcp_server.tool()
def list_knowledge_bases(params: ListKnowledgeBasesParams) -> Dict[str, Any]:
"""List knowledge bases from ServiceNow"""
logger.info("list_knowledge_bases called with params: %s", params)
try:
result = list_knowledge_bases_tool(self.config, self.auth_manager, params)
logger.info("list_knowledge_bases_tool returned: %s", result)
# Third approach - match script_include tools exactly by returning raw dictionary
logger.info("Using approach: Return raw dictionary (matching script_include tools)")
return result
except Exception as e:
logger.error("Error in list_knowledge_bases: %s", str(e), exc_info=True)
return {"success": False, "message": f"Error: {str(e)}"}
@self.mcp_server.tool()
def create_category(params: CreateCategoryParams) -> str:
"""Create a new category in a knowledge base"""
return json.dumps(create_category_tool(self.config, self.auth_manager, params).dict())
@self.mcp_server.tool()
def create_article(params: CreateArticleParams) -> str:
"""Create a new knowledge article"""
return json.dumps(create_article_tool(self.config, self.auth_manager, params).dict())
@self.mcp_server.tool()
def update_article(params: UpdateArticleParams) -> str:
"""Update an existing knowledge article"""
return json.dumps(update_article_tool(self.config, self.auth_manager, params).dict())
@self.mcp_server.tool()
def publish_article(params: PublishArticleParams) -> str:
"""Publish a knowledge article"""
return json.dumps(publish_article_tool(self.config, self.auth_manager, params).dict())
@self.mcp_server.tool()
def list_articles(params: ListArticlesParams) -> Dict[str, Any]:
"""List knowledge articles"""
logger.info("list_articles called with params: %s", params)
try:
result = list_articles_tool(self.config, self.auth_manager, params)
logger.info("list_articles_tool returned type: %s", type(result))
return result
except Exception as e:
logger.error("Error in list_articles: %s", str(e), exc_info=True)
return {"success": False, "message": f"Error: {str(e)}"}
@self.mcp_server.tool()
def get_article(params: GetArticleParams) -> Dict[str, Any]:
"""Get a specific knowledge article by ID"""
logger.info("get_article called with params: %s", params)
try:
result = get_article_tool(self.config, self.auth_manager, params)
logger.info("get_article_tool returned type: %s", type(result))
return result
except Exception as e:
logger.error("Error in get_article: %s", str(e), exc_info=True)
return {"success": False, "message": f"Error: {str(e)}"}
@self.mcp_server.tool()
def list_categories(params: ListCategoriesParams) -> Dict[str, Any]:
"""List categories in a knowledge base"""
logger.info("list_categories called with params: %s", params)
try:
result = list_categories_tool(self.config, self.auth_manager, params)
logger.info("list_categories_tool returned type: %s", type(result))
return result
except Exception as e:
logger.error("Error in list_categories: %s", str(e), exc_info=True)
return {"success": False, "message": f"Error: {str(e)}"}
# User management tools
@self.mcp_server.tool()
def create_user(params: CreateUserParams) -> Dict[str, Any]:
"""Create a new user in ServiceNow"""
return create_user_tool(
self.config,
self.auth_manager,
params,
)
@self.mcp_server.tool()
def update_user(params: UpdateUserParams) -> Dict[str, Any]:
"""Update an existing user in ServiceNow"""
return update_user_tool(
self.config,
self.auth_manager,
params,
)
@self.mcp_server.tool()
def get_user(params: GetUserParams) -> Dict[str, Any]:
"""Get a specific user in ServiceNow"""
return get_user_tool(
self.config,
self.auth_manager,
params,
)
@self.mcp_server.tool()
def list_users(params: ListUsersParams) -> Dict[str, Any]:
"""List users in ServiceNow"""
return list_users_tool(
self.config,
self.auth_manager,
params,
)
@self.mcp_server.tool()
def create_group(params: CreateGroupParams) -> Dict[str, Any]:
"""Create a new group in ServiceNow"""
return create_group_tool(
self.config,
self.auth_manager,
params,
)
@self.mcp_server.tool()
def update_group(params: UpdateGroupParams) -> Dict[str, Any]:
"""Update an existing group in ServiceNow"""
return update_group_tool(
self.config,
self.auth_manager,
params,
)
@self.mcp_server.tool()
def add_group_members(params: AddGroupMembersParams) -> Dict[str, Any]:
"""Add members to an existing group in ServiceNow"""
return add_group_members_tool(
self.config,
self.auth_manager,
params,
)
@self.mcp_server.tool()
def remove_group_members(params: RemoveGroupMembersParams) -> Dict[str, Any]:
"""Remove members from an existing group in ServiceNow"""
return remove_group_members_tool(
self.config,
self.auth_manager,
params,
)
@self.mcp_server.tool()
def list_groups(params: ListGroupsParams) -> Dict[str, Any]:
"""List groups from ServiceNow with optional filtering"""
return list_groups_tool(
self.config,
self.auth_manager,
params,
)
def start(self):
"""Start the MCP server."""
self.mcp_server.run()
def stop(self):
"""Stop the MCP server."""
# Cleanup resources if needed
pass
def create_servicenow_mcp(instance_url: str, username: str, password: str):
"""
Create a ServiceNow MCP server with minimal configuration.
This is a simplified factory function that creates a pre-configured
ServiceNow MCP server with basic authentication.
Args:
instance_url: ServiceNow instance URL
username: ServiceNow username
password: ServiceNow password
Returns:
A configured ServiceNowMCP instance ready to use
Example:
```python
from servicenow_mcp.server import create_servicenow_mcp
# Create an MCP server for ServiceNow
mcp = create_servicenow_mcp(
instance_url="https://instance.service-now.com",
username="admin",
password="password"
)
# Start the server
mcp.start()
```
"""
# Create basic auth config
auth_config = AuthConfig(
type=AuthType.BASIC, basic=BasicAuthConfig(username=username, password=password)
)
# Create server config
config = ServerConfig(instance_url=instance_url, auth=auth_config)
# Create and return server
return ServiceNowMCP(config)
# Create a standard variable that MCP CLI can recognize
# This will be used when running `mcp install src/servicenow_mcp/server.py`
# The actual configuration will be loaded from environment variables
# Load environment variables
load_dotenv()
# Get configuration from environment variables
instance_url = os.getenv("SERVICENOW_INSTANCE_URL")
username = os.getenv("SERVICENOW_USERNAME")
password = os.getenv("SERVICENOW_PASSWORD")
# Create the server instance with a standard variable name
# This is the variable that MCP CLI will look for
if instance_url and username and password:
server = create_servicenow_mcp(instance_url=instance_url, username=username, password=password)
else:
# Create a dummy server with default values for MCP CLI to discover
# The actual configuration will be loaded from environment variables when run
server = ServiceNowMCP(
{
"instance_url": "https://example.service-now.com",
"auth": {"type": "basic", "basic": {"username": "admin", "password": "password"}},
}
)
