Suzieq MCP

🚀 MCP サーバーガイド（SuzieQ ベースの実装）

MCP サーバーは、SuzieQ をベースにしたシステムで、ネットワークデータの取得や分析を行うことができます。このガイドでは、MCP サーバーのインストール、設定、起動、使用方法について説明します。

🚀 クイックスタート

MCP サーバーをすぐに起動するには、以下の手順に従ってください。

📦 インストール

依存関係のインストール

1. Python 3.x
2. uv バックグラウンド実行ツール (もし uv がインストールされていない場合は、他のバックグラウンド実行ツールを使用できます)

設定手順

1. コードリポジトリをダウンロードして解凍します。
2. プロジェクトのルートディレクトリに .env ファイルを作成し、以下の内容を追加します。

SUZIEQ_API_ENDPOINT=your_api_endpoint
SUZIEQ_API_KEY=your_api_key

💻 サービスの起動

起動コマンド

uv run python main.py

パラメータの説明

• --env-file: .env ファイルのパスを指定します（オプション、デフォルトは現在のディレクトリ）。

💻 使用例

基本的な使用法

run_suzieq_show

def run_suzieq_show(table: str, filters: Optional[Dict[str, Any]] = None) -> str:
    """
    查询 SuzieQ 数据库中的指定表。
    
    参数:
        table (str): 表名（例如 "device", "interface", "bgp"）。
        filters (Optional[Dict[str, Any]]): 过滤条件（可选，默认为空）。
        
    返回:
        str: 查询结果的 JSON 格式字符串，或錯誤信息。
    """

run_suzieq_summarize

def run_suzieq_summarize(table: str, filters: Optional[Dict[str, Any]] = None) -> str:
    """
    簮結 SuzieQ 数据库中的指定表。
    
    参数:
        table (str): 表名（例如 "device", "interface", "bgp"）。
        filters (Optional[Dict[str, Any]]): 过滤条件（可选，默认为空）。
        
    返回:
        str: 簮結結果的 JSON 格式字符串，或錯誤信息。
    """

高度な使用法

run_suzieq_show の例

{
  "table": "device"
}

すべてのデバイス情報を返します。

{
  "table": "bgp",
  "filters": { "hostname": "spine01" }
}

hostname が spine01 の BGP ネイバー情報を返します。

run_suzieq_summarize の例

{
  "table": "interface",
  "filters": { "vrf": "default", "state": "up" }
}

VRF が default で状態が up のインターフェース情報を返します。

📚 トラブルシューティング

エラー: SuzieQ API エンドポイントまたはキーが設定されていません

• .env ファイルがプロジェクトのルートディレクトリにあることを確認してください。
• SUZIEQ_API_ENDPOINT と SUZIEQ_API_KEY が正しく設定されていることを確認してください。

その他のエラー

• ログファイルを確認して、詳細なエラー情報を取得してください。
• API サービスが実行中でアクセス可能であることを確認してください。