Suzieq MCP

🚀 MCP Server Guide (Implementation based on SuzieQ)

This guide provides a comprehensive overview of setting up, configuring, and using an MCP server based on SuzieQ. It covers installation, service startup, tool usage, example scenarios, and troubleshooting.

📦 Installation and Configuration

Install Dependencies

1. Python 3.x
2. uv Background Running Tool (If you haven't installed uv, you can use other background running tools)

Configuration Steps

1. Download and extract the code repository.
2. Create a .env file in the project root directory and add the following content:

   SUZIEQ_API_ENDPOINT=your_api_endpoint
   SUZIEQ_API_KEY=your_api_key
   

🚀 Service Startup

Startup Command

uv run python main.py

Parameter Explanation

• --env-file: Specify the path to the .env file (optional, default is the current directory).

💻 Usage Examples

Basic Usage

def run_suzieq_show(table: str, filters: Optional[Dict[str, Any]] = None) -> str:
    """
    Query a specified table in the SuzieQ database.
    
    Args:
        table (str): Table name (e.g., "device", "interface", "bgp").
        filters (Optional[Dict[str, Any]]): Filter conditions (optional, default is empty).
        
    Returns:
        str: JSON-formatted string of the query result, or an error message.
    """

Advanced Usage

def run_suzieq_summarize(table: str, filters: Optional[Dict[str, Any]] = None) -> str:
    """
    Summarize a specified table in the SuzieQ database.
    
    Args:
        table (str): Table name (e.g., "device", "interface", "bgp").
        filters (Optional[Dict[str, Any]]): Filter conditions (optional, default is empty).
        
    Returns:
        str: JSON-formatted string of the summary result, or an error message.
    """

Example of run_suzieq_show

{
  "table": "device"
}

Returns information about all devices.

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

Returns information about BGP neighbors with the hostname "spine01".

Example of run_suzieq_summarize

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

Returns information about interfaces with VRF "default" and state "up".

🛠️ Troubleshooting

Error: SuzieQ API endpoint or key not configured

• Ensure that the .env file is located in the project root directory.
• Check if SUZIEQ_API_ENDPOINT and SUZIEQ_API_KEY are correctly configured.

Other Errors

• Check the log file for more error information.
• Ensure that the API service is running and accessible.