Skip to main content
Glama
Sign In
enesjakozh

SuzieQ MCP Server

by PovedaAqui
GitHub
Python
MIT License
2
  • Apple
  • Linux
OverviewInspectNewSchemaRelated ServersReviewsScore
Need Help?View Source CodeReport Issue

Integrations

  • Used for loading environment variables from a .env file to securely store and access the SuzieQ API endpoint and access token.

  • Serves as the runtime environment for the MCP server, with version 3.8 or higher recommended.

SuzieQ용 MCP 서버

이 프로젝트는 언어 모델과 다른 MCP 클라이언트가 REST API를 통해 SuzieQ 네트워크 관찰 인스턴스와 상호 작용할 수 있도록 하는 MCP(Model Context Protocol) 서버를 제공합니다.

개요

서버는 SuzieQ의 명령을 MCP 도구로 공개합니다.

  • run_suzieq_show : 'show' 명령에 액세스하여 자세한 네트워크 상태 테이블을 쿼리합니다.
  • run_suzieq_summarize : 'summarize' 명령에 액세스하여 집계된 통계 및 요약을 가져옵니다.

이러한 도구를 사용하면 클라이언트(예: Claude Desktop)가 다양한 네트워크 상태 테이블(예: 인터페이스, BGP, 경로)을 쿼리하고 필터를 적용하여 SuzieQ 인스턴스에서 직접 결과를 검색할 수 있습니다.

필수 조건

  • Python: 버전 3.8 이상을 권장합니다.
  • uv: 빠른 Python 패키지 설치 및 해결 프로그램입니다. ( 설치 가이드 )
  • SuzieQ 인스턴스: REST API가 활성화되어 접근 가능한 실행 중인 SuzieQ 인스턴스입니다.
  • SuzieQ API 엔드포인트 및 키: SuzieQ API의 URL(예: http://your-suzieq-host:8000/api/v2 )과 유효한 API 키( access_token )가 필요합니다.

설치 및 설정

Smithery를 통해 설치

Smithery를 통해 Claude Desktop에 suzieq-mcp를 자동으로 설치하려면:

지엑스피1

수동 설치

  1. 코드 가져오기: 이 저장소를 복제하거나 main.py 및 server.py 파일을 전용 프로젝트 디렉토리에 다운로드하세요.
  2. 가상 환경 만들기: 터미널에서 프로젝트 디렉토리로 이동하고 uv 사용하여 가상 환경을 만듭니다.
    uv venv
  3. 환경 활성화:
    • macOS/Linux의 경우:
      source .venv/bin/activate
    • Windows의 경우:GXP4 (프롬프트 앞에 (.venv) 가 표시되어야 함)
  4. 종속성 설치: uv 사용하여 필요한 Python 패키지를 설치합니다.
    uv pip install mcp httpx python-dotenv
    • mcp : 모델 컨텍스트 프로토콜 SDK.
    • httpx : SuzieQ API와 통신하는 데 사용되는 비동기 HTTP 클라이언트입니다.
    • python-dotenv : 구성을 위해 .env 파일에서 환경 변수를 로드하는 데 사용됩니다.

구성

서버에는 SuzieQ API 엔드포인트와 API 키가 필요합니다. 안전하고 간편한 설정을 위해 .env 파일을 사용하세요.

  1. .env 파일을 만듭니다. 프로젝트 디렉토리의 루트 ( main.py 와 같은 위치)에 .env 라는 이름의 파일을 만듭니다.
  2. 자격 증명 추가: SuzieQ 엔드포인트와 키를 .env 파일에 추가합니다. 키/엔드포인트 자체에 포함된 경우를 제외하고 값을 따옴표로 묶지 마십시오.
    # .env SUZIEQ_API_ENDPOINT=http://your-suzieq-host:8000/api/v2 SUZIEQ_API_KEY=your_actual_api_key
    플레이스홀더 값을 실제 엔드포인트와 키로 바꾸세요.
  3. .env 파일 보안: .gitignore 파일에 .env 추가하여 실수로 기밀을 커밋하는 것을 방지합니다.
    echo ".env" >> .gitignore
  4. 코드 통합: 제공된 server.py 서버가 시작될 때 자동으로 python-dotenv 사용하여 이러한 변수를 로드합니다.

서버 실행

가상 환경이 활성화되어 있는지 확인하세요. 서버가 현재 디렉터리의 .env 파일에서 구성을 로드합니다.

1. 직접

터미널에서 직접 서버를 실행하세요.

uv run python main.py

서버가 시작되고 Starting SuzieQ MCP Server... 라는 메시지가 출력되며, 표준 입출력(stdio)을 통해 MCP 연결을 수신합니다. 도구를 통해 API 쿼리에 성공하면 [INFO] 로그가 표시됩니다. Ctrl+C 눌러 서버를 중지하세요.

2. MCP Inspector 사용(디버깅용)

MCP Inspector는 도구를 직접 테스트하는 데 유용합니다. mcp CLI 도구가 설치되어 있는 경우( uv pip install "mcp[cli]" ) 다음을 실행하세요.

uv run mcp dev main.py

대화형 디버거가 실행됩니다. "도구" 탭으로 이동하여 run_suzieq_show 선택하고 매개변수(예: table: "device")를 입력한 후 "도구 호출"을 클릭하여 테스트하세요.

Claude Desktop과 함께 사용

원활한 사용을 위해 Claude Desktop과 서버를 통합하세요.

  1. Claude Desktop Config 찾기: claude_desktop_config.json 파일을 찾습니다.
    • macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
    • Windows: %APPDATA%\Claude\claude_desktop_config.json
    • 해당 파일과 Claude 디렉토리가 없으면 새로 만듭니다.
  2. 구성 파일 편집: 이 서버에 대한 항목을 추가하세요. main.py 의 절대 경로를 사용하세요. 서버는 .env 에서 시크릿을 로드하므로 이 구성 파일에 포함할 필요가 없습니다.
{ "mcpServers": { "suzieq-server": { // Use 'uv' if it's in the system PATH Claude uses, // otherwise provide the full path to the uv executable. "command": "uv", "args": [ "run", "python", // --- VERY IMPORTANT: Use the ABSOLUTE path below --- "/full/path/to/your/project/mcp-suzieq-server/main.py" ], // 'env' block is not needed here if .env is in the project directory above "workingDirectory": "/full/path/to/your/project/mcp-suzieq-server/" // Optional, but recommended } // Add other servers here if needed } }
  • /full/path/to/your/project/mcp-suzieq-server/main.py 를 시스템의 올바른 절대 경로로 바꾸세요.
  • /full/path/to/your/project/mcp-suzieq-server/``main.py 와 .env 가 있는 디렉터리의 절대 경로로 바꾸세요. workingDirectory 설정하면 .env 파일을 찾을 수 있습니다.
  • 클로드가 uv 찾지 못하면 "uv" 절대 경로로 바꿉니다( which uv 또는 where uv 통해 찾을 수 있음).
  • Windows에서 텍스트 인코딩 문제가 발생하면 "env": { "PYTHONUTF8": "1" } 필요할 수 있습니다.
  1. Claude Desktop을 다시 시작합니다. Claude Desktop을 완전히 닫았다가 다시 엽니다.
  2. 확인: Claude Desktop에서 MCP 도구 표시기(망치 아이콘 🔨)를 찾으세요. 클릭하면 run_suzieq_show 및 run_suzieq_summarize 도구가 모두 표시됩니다.

도구 사용(run_suzieq_show)

run_suzieq_show(table: str, filters: Optional[Dict[str, Any]] = None) -> str
  • table : (문자열, 필수) SuzieQ 테이블 이름(예: "device", "interface", "bgp").
  • 필터 : (사전, 선택 사항) 필터링을 위한 키-값 쌍(예: "hostname": "leaf01" ). 필터가 없으면 생략하거나 {} 사용합니다.
  • 반환 : 결과 또는 오류가 포함된 JSON 문자열입니다.

예시 호출(개념적):

모든 장치 표시:

{ "table": "device" }

호스트 이름 'spine01'에 대한 BGP 이웃 표시:

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

VRF '기본'에서 'up' 인터페이스 표시:

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

도구 사용(run_suzieq_summarize)

run_suzieq_summarize(table: str, filters: Optional[Dict[str, Any]] = None) -> str
  • table : (문자열, 필수) 요약할 SuzieQ 테이블 이름(예: "device", "interface", "bgp").
  • 필터 : (사전, 선택 사항) 필터링을 위한 키-값 쌍(예: "hostname": "leaf01" ). 필터가 없으면 생략하거나 {} 사용합니다.
  • 반환값 : 요약된 결과 또는 오류가 포함된 JSON 문자열입니다.

예시 호출(개념적):

모든 장치를 요약하세요:

{ "table": "device" }

호스트 이름 'spine01'로 BGP 세션을 요약합니다.

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

VRF '기본'에서 인터페이스 상태를 요약합니다.

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

문제 해결

오류: "SuzieQ API 엔드포인트 또는 키가 구성되지 않았습니다...":

  • .env 파일이 main.py 와 같은 디렉토리에 있는지 확인하세요.
  • SUZIEQ_API_ENDPOINT 와 SUZIEQ_API_KEY 가 올바르게 입력되었고 .env 에 유효한 값이 있는지 확인하세요.
  • Claude Desktop을 사용하는 경우 claude_desktop_config.json 의 workingDirectory``.env 포함된 디렉토리를 가리키는지 확인하세요.

HTTP 오류(4xx, 5xx):

  • SuzieQ API 키( SUZIEQ_API_KEY )가 올바른지 확인하세요(401/403 오류).
  • SUZIEQ_API_ENDPOINT 가 올바르고 API 서버가 실행 중인지 확인하세요.

You must be authenticated.

A
security – no known vulnerabilities
A
license - permissive license
A
quality - confirmed to work

remote-capable server

The server can be hosted and run remotely because it primarily relies on remote services or has no dependency on the local environment.

Tools

REST API를 통해 언어 모델 및 기타 MCP 클라이언트가 SuzieQ 네트워크 관찰 인스턴스와 상호 작용할 수 있도록 하는 MCP(모델 컨텍스트 프로토콜) 서버입니다.

  1. 개요
    1. 필수 조건
      1. 설치 및 설정
        1. Smithery를 통해 설치
        2. 수동 설치
      2. 구성
        1. 서버 실행
          1. 직접
          2. MCP Inspector 사용(디버깅용)
        2. Claude Desktop과 함께 사용
          1. 도구 사용(run\_suzieq\_show)
            1. 예시 호출(개념적):
          2. 도구 사용(run\_suzieq\_summarize)
            1. 예시 호출(개념적):
          3. 문제 해결
            1. 오류: "SuzieQ API 엔드포인트 또는 키가 구성되지 않았습니다...":
            2. HTTP 오류(4xx, 5xx):

          Related Resources

          Related MCP Servers

          • Supabase MCP Server

            JoshuaRileyDev
            A
            security
            F
            license
            A
            quality
            A Model Context Protocol (MCP) server that provides programmatic access to the Supabase Management API. This server allows AI models and other clients to manage Supabase projects and organizations through a standardized interface.
            Last updated -
            8
            84
            27
            JavaScript

          • MCP Maker

            CaptainCrouton89
            -
            security
            -
            license
            -
            quality
            A specialized server that helps users create new Model Context Protocol (MCP) servers by providing tools and templates for scaffolding projects with various capabilities.
            Last updated -
            1
            TypeScript

          • MCP API Service

            nstanw
            -
            security
            -
            license
            -
            quality
            A Model Context Protocol (MCP) server that interacts with system APIs, allowing users to check connections, search employees, register breakfast, and update chemical information by shifts.
            Last updated -
            2

          • API-Market MCP Server

            Noveum
            -
            security
            A
            license
            -
            quality
            A Model Context Protocol server that exposes over 200+ APIs from API.market as MCP resources, allowing large language models to discover and interact with various APIs through natural language commands.
            Last updated -
            111
            2
            TypeScript
            MIT License
            • Apple

          View all related MCP servers

          New MCP Servers

          ID: rs1x5l381d