Tripura State Board Of Secondary Education Tripura

🚀 MCP Server

This project is an MCP (Model Context Protocol) Server tailored for the provided OpenAPI URL - https://api.apis.guru/v2/specs/apisetu.gov.in/tbse/3.0.0/openapi.json. It is auto - generated using AG2's MCP builder.

🚀 Quick Start

The MCP Server is designed to handle specific OpenAPI specifications. You can start by following the installation and running steps below.

✨ Features

• Auto - generated from AG2's MCP builder for the given OpenAPI URL.
• Supports different transport modes like stdio, sse, streamable - http.
• Configurable via environment variables.

📦 Installation

Prerequisites

• Python 3.9+
• pip and uv

Steps

1. Clone the repository:

   git clone <repository-url>
   cd mcp-server
   

2. Install dependencies: The .devcontainer/setup.sh script takes care of installing dependencies using pip install -e ".[dev]". If you're not using the dev container, you can run this command manually.

   pip install -e ".[dev]"
   

   Alternatively, you can use uv:

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

💻 Usage Examples

Starting the Server

To start the server in stdio mode:

python mcp_server/main.py stdio

Testing the Server

The tests/test_mcp_server.py file shows how to start and interact with the server programmatically for testing.

📚 Documentation

Development

This project uses ruff for linting and formatting, mypy for static type checking, and pytest for testing.

Linting and Formatting

To check for linting issues:

ruff check

To format the code:

ruff format

These commands are also available via the scripts/lint.sh script.

Static Analysis

To run static analysis (mypy, bandit, semgrep):

./scripts/static-analysis.sh

This script is also configured as a pre - commit hook in .pre-commit-config.yaml.

Running Tests

To run tests with coverage:

./scripts/test.sh

This will run pytest and generate a coverage report. For a combined report and cleanup, you can use:

./scripts/test-cov.sh

Pre - commit Hooks

This project uses pre - commit hooks defined in .pre-commit-config.yaml. To install the hooks:

pre-commit install

The hooks will run automatically before each commit.

Server Configuration

The server can be configured using environment variables:

• CONFIG_PATH: Path to a JSON configuration file (e.g., mcp_server/mcp_config.json).
• CONFIG: A JSON string containing the configuration.
• SECURITY: Environment variables for security parameters (e.g., API keys).

Refer to the if __name__ == "__main__": block in mcp_server/main.py for details on how these are loaded.

Building and Publishing

This project uses Hatch for building and publishing. To build the project:

hatch build

To publish the project:

hatch publish

These commands are also available via the scripts/publish.sh script.