Mineskin Api

🚀 MCP Server

This project is an MCP (Model Context Protocol) Server for the given OpenAPI URL - https://api.apis.guru/v2/specs/mineskin.org/1.0.0/openapi.json, auto - generated using AG2's MCP builder. It provides a convenient way to interact with the specified API following the MCP.

🚀 Quick Start

Prerequisites

• Python 3.9+
• pip and uv

Installation

1. Clone the repository:

git clone <repository-url>
cd mcp-server

2. Install dependencies: The .devcontainer/setup.sh script handles installing dependencies using pip install -e ".[dev]". If you are 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]"

✨ Features

• Linting and Formatting: Uses ruff for linting and formatting.
• Static Type Checking: Employs mypy for static type checking.
• Testing: Utilizes pytest for testing.
• Multiple Transport Modes: The server supports different transport modes like stdio, sse, streamable - http.
• Configuration via Environment Variables: Allows configuration using environment variables such as CONFIG_PATH, CONFIG, and SECURITY.
• Building and Publishing with Hatch: Facilitates building and publishing using Hatch.

💻 Usage Examples

Basic Usage

Starting the Server

To start the server in stdio mode:

python mcp_server/main.py stdio

Advanced Usage

Configuring the Server

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.

Testing the Server

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

📦 Installation

The installation steps are already described in the Quick Start section.

📚 Documentation

Development

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](.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](.pre - commit - config.yaml). To install the hooks:

pre - commit install

The hooks will run automatically before each commit.

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.