🚀 ServiceNow MCP Server

🚀 ServiceNow MCP サーバー

📋 概要

このリポジトリには、Model Context Protocol（MCP）用の ServiceNow 統合サーバーが含まれています。標準化されたプロトコルを通じて、ServiceNow インスタンスと AI モデルのシームレスな連携を可能にし、インシデント管理、ナレッジベース記事の作成、その他の ServiceNow 操作を自動化できます。

✨ 特長

• 🔌 ServiceNow 統合：ServiceNow インスタンスと直接連携します
• 🛠️ 複数の操作に対応：
  • インシデントの作成と管理
  • ナレッジベース記事の作成
  • クライアントスクリプトの作成
  • ビジネスルールの作成
  • SLA 定義の作成
  • レコードプロデューサーの作成
• 🔒 安全な認証：環境変数を利用した認証情報の管理
• 🚀 FastAPI ベースのサーバー：高性能な非同期操作

🛠️ 前提条件

• Python 3.12 以上
• 適切な API アクセス権を持つ ServiceNow インスタンス
• 有効な ServiceNow 認証情報
• 任意：AI 機能を利用する場合は Gemini API キー
• サーバーの実行に必要な UV icorn
• サーバーの構築に必要な FastAPI

⚙️ 設定

1. リポジトリをクローンします。

   git clone https://github.com/your-org/mcp-server-now.git
   cd mcp-server-now
   

2. 認証情報を記載した .env ファイルを作成します。

   SERVICENOW_INSTANCE=https://your-instance.service-now.com
   SERVICENOW_USERNAME=your_username
   SERVICENOW_PASSWORD=your_password
   GEMINI_API_KEY=your_api_key  # Optional
   

3. 依存関係をインストールします。

   pip install -e .
   

🚀 はじめに

サーバーの実行

mcp install <file_name>.py

使用例

このサーバーは、ServiceNow 操作用の複数のツールを提供します。以下に例を示します。

1. インシデントを作成する：

   create_incident(
       short_description="Network outage in building B",
       description="Users reporting connectivity issues",
       urgency="2",
       impact="2"
   )
   

2. ナレッジベース記事を作成する：

   create_kb_article(
       short_description="How to Reset Your Password",
       article_body="<h1>Password Reset Instructions</h1><p>1. Navigate to the login page</p>",
       workflow_state="published"
   )
   

その他の例については、servicenow-test-examples.md を参照してください。

🧩 利用可能なツール

このサーバーは以下のツールを提供します。

• create_incident：新しいインシデントを作成します
• create_kb_article：ナレッジベース記事を作成します
• create_client_script：クライアントサイドスクリプトを作成します
• create_business_rule：ビジネスルールを作成します
• create_sla_definition：SLA 定義を作成します
• create_record_producer：カスタマイズ可能な変数を使用してレコードプロデューサーを作成します
• create_variable_set：カタログアイテムで再利用できる変数セットを作成します

レコードプロデューサーの詳細

create_record_producer ツールを使用すると、以下の機能を備えた ServiceNow レコードプロデューサーを作成できます。

create_record_producer(
    name="Report Network Issue",
    table_name="incident",
    short_description="Use this form to report network connectivity issues",
    category_sys_id="optional_category_sys_id",
    script="optional_server_side_script",
    variables=[
        {
            "name": "issue_type",
            "label": "Type of Issue",
            "type": "choice",
            "choices": ["Connectivity", "Performance", "Access"],
            "mandatory": True
        },
        {
            "name": "affected_users",
            "label": "Number of Affected Users",
            "type": "integer",
            "mandatory": True
        }
    ]
)

主な機能：

• さまざまな型（文字列、整数、ブール値、参照など）を指定できるカスタマイズ可能なフォームフィールド
• サーバーサイドスクリプトへの対応
• カテゴリの割り当て
• 必須フィールドの設定
• デフォルト値とヘルプテキスト

変数セット

create_variable_set ツールを使用すると、複数のカタログアイテムに追加できる再利用可能な変数セットを作成できます。

create_variable_set(
    name="Hardware Request Variables",
    description="Common variables for hardware requests",
    variables=[
        {
            "name": "device_type",
            "label": "Device Type",
            "type": "choice",
            "choices": ["Laptop", "Desktop", "Tablet", "Phone"],
            "mandatory": True
        },
        {
            "name": "justification",
            "label": "Justification",
            "type": "text",
            "mandatory": True,
            "help_text": "Please explain why you need this hardware"
        }
    ]
)

変数セットで対応している機能：

• 複数の変数型（文字列、整数、ブール値、参照、選択肢など）
• カスタム検証ルール
• ヘルプテキストと説明
• 必須フィールドの設定
• デフォルト値
• 他の ServiceNow テーブルへの参照フィールド

🔧 開発

プロジェクト構成

mcp-server-now/
├── servicenow.py          # Main server implementation
├── servicenow-test-examples.md  # Example usage
├── pyproject.toml         # Project configuration
├── .env                   # Environment variables
└── README.md             # This file

新しいツールの追加

ServiceNow の操作を追加するには、以下の手順を実行します。

1. servicenow.py に新しい非同期関数を作成します
2. @mcp.tool() でデコレートします
3. 適切なドキュメントとエラー処理を追加します
4. 新しい機能をテストします

📚 リソース

• Model Context Protocol のドキュメント
• ServiceNow REST API のドキュメント
• FastAPI のドキュメント

📄 ライセンス

このプロジェクトは MIT License の下でライセンスされています。詳細は LICENSE ファイルを参照してください。

📞 サポート

サポートが必要な場合は、以下をお試しください。

• このリポジトリで issue を作成する
• メンテナーに連絡する
• ServiceNow のドキュメントを確認する

👤 Author

---

🎥 Watch Live Demo

🔗 Youtube Link

Live Demo