Skip to main content

MCP Server

Project description

MCP Server

This project is an MCP (Model Context Protocol) Server for the given OpenAPI URL - https://api.apis.guru/v2/specs/openpolicy.local/0.28.0/openapi.json, auto-generated using AG2's MCP builder.

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

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.

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

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mcp_server_shalini12345-0.0.1.tar.gz (18.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

mcp_server_shalini12345-0.0.1-py3-none-any.whl (12.6 kB view details)

Uploaded Python 3

File details

Details for the file mcp_server_shalini12345-0.0.1.tar.gz.

File metadata

File hashes

Hashes for mcp_server_shalini12345-0.0.1.tar.gz
Algorithm Hash digest
SHA256 dc82f5eb69d2bec6d1c8d7a4bc6e7764727650e01fa6dba859d795fe2a50cfb1
MD5 7f9356278702ad7f7688efb864bfd00a
BLAKE2b-256 9c49e7144c74a3529176b8f497858a63a26298ec4a2bdfb247482db59f3f7a82

See more details on using hashes here.

File details

Details for the file mcp_server_shalini12345-0.0.1-py3-none-any.whl.

File metadata

File hashes

Hashes for mcp_server_shalini12345-0.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 03192b5abed802a630d94b7af6378638bd95331a1314cec04821c38ae71be604
MD5 8325da699f3d09b67f1817d88ecfdde8
BLAKE2b-256 e3a7f0d471fbde57bc3a258b9472102486584df5a1095d0272bdaaa6d1492d2d

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page