MCP 서버

이 프로젝트는 AG2의 MCP 빌더를 사용하여 자동 생성된 OpenAPI URL - https://api.apis.guru/v2/specs/apisetu.gov.in/hpsssb/3.0.0/openapi.json 에 대한 MCP(Multi-Agent Conversation Protocol) 서버입니다.

필수 조건

• 파이썬 3.9 이상

• pip와 uv

Related MCP server: Punjab Technical Education MCP Server

설치

1. 저장소를 복제합니다.

   지엑스피1

2. 종속성 설치: .devcontainer/setup.sh 스크립트는 pip install -e ".[dev]" 사용하여 종속성을 설치합니다. dev 컨테이너를 사용하지 않는 경우 이 명령을 수동으로 실행할 수 있습니다.

   pip install -e ".[dev]"

   또는 uv 사용할 수 있습니다.

   uv pip install --editable ".[dev]"

개발

이 프로젝트에서는 린팅과 포맷팅에 ruff 사용하고, 정적 유형 검사에 mypy 사용하고, 테스트에 pytest .

린팅 및 포맷팅

린팅 문제를 확인하려면:

ruff check

코드를 포맷하려면:

ruff format

이러한 명령은 scripts/lint.sh 스크립트를 통해서도 사용할 수 있습니다.

정적 분석

정적 분석(mypy, bandit, semgrep)을 실행하려면:

./scripts/static-analysis.sh

이 스크립트는 .pre-commit-config.yaml 에서 사전 커밋 후크로도 구성됩니다.

테스트 실행

적용 범위를 사용하여 테스트를 실행하려면 다음을 수행합니다.

./scripts/test.sh

이렇게 하면 pytest가 실행되고 커버리지 보고서가 생성됩니다. 보고서와 정리 작업을 결합하려면 다음을 사용할 수 있습니다.

./scripts/test-cov.sh

사전 커밋 후크

이 프로젝트는 .pre-commit-config.yaml 에 정의된 사전 커밋 후크를 사용합니다. 후크를 설치하려면 다음을 수행하세요.

pre-commit install

각 커밋 전에 후크가 자동으로 실행됩니다.

서버 실행

MCP 서버는 mcp_server/main.py 스크립트를 사용하여 시작할 수 있습니다. 다양한 전송 모드(예: stdio , sse )를 지원합니다.

서버를 시작하려면(예: stdio 모드에서):

python mcp_server/main.py stdio

서버는 환경 변수를 사용하여 구성할 수 있습니다.

• CONFIG_PATH : JSON 구성 파일의 경로(예: mcp_server/mcp_config.json ).

• CONFIG : 구성을 포함하는 JSON 문자열입니다.

• SECURITY : 보안 매개변수(예: API 키)에 대한 환경 변수입니다.

자세한 내용은 mcp_server/main.py 의 if __name__ == "__main__": 블록을 참조하세요.

tests/test_mcp_server.py 파일은 테스트를 위해 서버를 프로그래밍 방식으로 시작하고 상호 작용하는 방법을 보여줍니다.

건축 및 출판

이 프로젝트는 빌드 및 게시에 Hatch를 사용합니다. 프로젝트를 빌드하려면:

hatch build

프로젝트를 게시하려면:

hatch publish

이러한 명령은 scripts/publish.sh 스크립트를 통해서도 사용할 수 있습니다.