Servicenow MCP

🚀 ServiceNow Tools Documentation

This project offers tools and scripts for interacting with the ServiceNow system. Here are the main features:

• Service Catalog Integration: Integrate and manage the ServiceNow service catalog.
• Catalog Optimization: Provide functions to optimize the service catalog.
• Change Management: Create, manage, and operate change requests.
• Workflow Management: Design and execute workflows.
• Change Set Management: Manage collections of multiple change requests.
• Knowledge Base Integration: Integrate and serve knowledge base articles.
• User Management: Create, update, and manage users and groups.

🚀 Quick Start

Service Catalog Optimization Examples

The project includes demonstration scripts to show how to use the tools:

• examples/catalog_optimization_example.py: Demonstrates how to analyze and improve the ServiceNow service catalog.
• examples/change_management_demo.py: Demonstrates how to create and manage change requests.

✨ Features

Authentication Methods

Basic Authentication

SERVICENOW_AUTH_TYPE=basic
SERVICENOW_USERNAME=your-username
SERVICENOW_PASSWORD=your-password

OAuth Authentication

SERVICENOW_AUTH_TYPE=oauth
SERVICENOW_CLIENT_ID=your-client-id
SERVICENOW_CLIENT_SECRET=your-client-secret
SERVICENOW_TOKEN_URL=https://your-instance.service-now.com/oauth_token.do

API Key Authentication

SERVICENOW_AUTH_TYPE=api_key
SERVICENOW_API_KEY=your-api-key

📚 Documentation

More documentation can be found in the docs directory:

• Service Catalog Integration - Details about service catalog integration.
• Catalog Optimization Plan - Detailed planning for catalog optimization features.
• Change Management - Details about the change management tool.
• Workflow Management - Details about the workflow management tool.
• Change Set Management - Details about the change set management tool.

🔧 Technical Details

Troubleshooting

Common Errors in Change Management Tool

1. Error: argument after ** must be a mapping, not CreateChangeRequestParams

   • This error occurs when a CreateChangeRequestParams object instead of a dictionary is passed to the create_change_request function.
   • Solution: Ensure that a parameter dictionary is passed, not a Pydantic model object.
   • Note: The change management tool has been updated to handle this error automatically. The function now tries to unpack the parameters automatically, even if they are incorrectly wrapped or passed as a Pydantic model object.

2. Error: Missing required 'short_description' parameter

   • This error occurs when not all required parameters for creating a change request are provided.
   • Solution: Ensure that all required parameters are included. For create_change_request, both short_description and type are required.

3. Error: Invalid 'type' parameter value

   • This error occurs when an invalid value is passed to the type parameter.
   • Solution: Use a valid value: "normal", "standard", or "emergency".

4. Error: Cannot find the get_headers method in auth_manager or server_config

   • This error occurs when the authentication configuration is incorrect.
   • Solution: Check and ensure that the auth_manager and server_config are configured correctly. Refer to Authentication Documentation for setup.

🤝 Contribution Guidelines

How to Contribute Code

1. Clone the Repository: Clone this repository using Git.
2. Create a Feature Branch: Create a new branch for new features or fixes.
3. Commit Changes: Commit your changes and add detailed commit messages.
4. Submit a Pull Request: Push the branch to the main repository to initiate a merge request.

How to Report Issues

• Report issues through the Issues page, including a detailed problem description and steps to reproduce.

📄 License

This project is licensed under the MIT License.