Shipengine Api

🚀 MCP Server

This project is an MCP (Model Context Protocol) Server designed for the provided OpenAPI URL - https://api.apis.guru/v2/specs/shipengine.com/1.1.202303022103/openapi.json. It is auto - generated using AG2's MCP builder, offering seamless integration and efficient operation within the specified context.

🚀 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 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]"

✨ Features

This project is equipped with multiple features to ensure high - quality development and operation:

• Linting and Formatting: Uses ruff to maintain code style and catch potential issues.
• Static Type Checking: Employs mypy for static analysis to enhance code reliability.
• Testing: Utilizes pytest to conduct comprehensive tests and generate coverage reports.
• Pre - commit Hooks: Automatically runs checks before each commit to maintain code quality.

💻 Usage Examples

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.

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

To install the hooks:

pre-commit install

The hooks will run automatically before each commit.

Running the Server

The MCP server can be started using the mcp_server/main.py script. It supports different transport modes (e.g., stdio, sse, streamable-http).

To start the server (e.g., in stdio mode):

python mcp_server/main.py stdio

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.

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

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.