Brest MCP Server

🚀 Brest MCP Server

The Brest MCP Server provides a robust infrastructure for managing MCP - based interactions and includes a checking tool for debugging and monitoring.

🚀 Quick Start

The Brest MCP Server is an implementation of the Model Context Protocol (MCP) for the Brest region. It offers a powerful infrastructure to manage MCP - based interactions and comes with an MCP checking tool for debugging and monitoring. The goal of this project is to simplify and reliably deploy and manage MCP services.

✨ Features

• Provide a powerful infrastructure for managing MCP - based interactions.
• Include an MCP checking tool for debugging and monitoring.
• Simplify and reliably deploy and manage MCP services.

📦 Installation

To install and configure the Brest MCP Server locally, follow these steps:

1. Install uv (if not already installed):

   • On Linux/macOS:

     curl -LsSf https://astral.sh/uv/install.sh | sh
     

   • On Windows:

     powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"
     

2. Clone the repository:

   git clone https://github.com/Nijal-AI/Brest-mcp-server.git
   cd Brest-mcp-server
   

3. Create and activate a virtual environment:

   uv venv
   source .venv/bin/activate  # On Windows: .venv\Scripts\activate
   

4. Install dependencies:

   uv sync
   

💻 Usage Examples

Basic Usage

To run the local server, follow these steps:

1. Ensure the virtual environment is activated:

   source .venv/bin/activate  # On Windows: .venv\Scripts\activate
   

2. Start the server using the MCP checking tool:

   npx @modelcontextprotocol/inspector uv run brest-mcp
   

3. Access the MCP checking tool in your browser:

   • Proxy: http://localhost:3000
   • Web interface: http://localhost:5173

Example output:

Starting the MCP checking tool...
The proxy server is listening on port 3000
🔍 The MCP checking tool is running at http://localhost:5173 🚀

Advanced Usage

If you want to use the Brest MCP Server to converse with an AI agent, you can use the provided client in the tools folder:

uv run python tools/client.py src/server.py

📚 Documentation

Tools

If you want to use the Brest MCP Server to interact with an AI agent, you can use the provided client in the tools folder:

uv run python tools/client.py src/server.py

Development

For developers who wish to contribute or develop advanced features, follow these additional steps:

1. Ensure the virtual environment is set up and dependencies are installed:

   uv venv
   uv sync
   

2. Use the MCP checking tool for debugging and monitoring:

   npx @modelcontextprotocol/inspector uv run brest-mcp
   

3. Refer to the pyproject.toml file for detailed information about dependencies and configuration.

Contributing

Contributions are welcome! To propose changes, refer to the CONTRIBUTING.md file.

🔧 Technical Details

• Language: Python 3.12.3 or compatible versions
• Dependency Management: uv
• Checking Tool: MCP checking tool via Node.js (npx)
• Environment: Virtual environment managed by uv
• Node.js: Used for the MCP checking tool

📄 License

This project is released under the MIT License. For detailed information, see the LICENSE file.