Omni Server

🚀 Omni Server

Omni Server is a server implementation based on the Model Context Protocol (MCP), designed to assist developers in getting familiar with the MCP framework. As a fundamental tool, it provides support for understanding and implementing MCP-based applications.

✨ Features

• 🚀 An MCP server implemented in Python.
• 📁 Adopts a modular project structure, clearly separating data files, prompt templates, tools, and resources.
• ⚙️ Supports flexible configuration through .env and Poetry.
• 🧠 Seamlessly integrates with Claude Desktop.

📁 Project Structure

omni-server/
├── data/           # Data files and datasets
├── prompts/        # Prompt templates and related files
├── resources/      # Static resources and assets
├── tools/          # Tool scripts and utilities
├── utils/          # Helper functions and tools
├── .env            # Environment variable definitions
├── .gitignore      # Git ignore rules
├── .python-version # Python version specification
├── README.md       # Project documentation
├── main.py         # Application entry point
├── pyproject.toml  # Project metadata and dependencies
├── server.py       # Server initialization and configuration
└── uv.lock         # Dependency lock file

🚀 Quick Start

Prerequisites

• Python 3.8 or higher.
• uv for dependency management.

Installation

1. Clone the repository:

git clone https://github.com/abhijithk1/omni-server.git
cd omni-server

2. Install dependencies using uv:

uv venv
uv pip install -r requirements.txt  # If using requirements.txt

# Or better:
uv pip install -e .  # If using pyproject.toml

3. Activate the virtual environment (if necessary):

source .venv/bin/activate  # macOS/Linux
.venv\Scripts\activate     # Windows

4. Create a .env file (if needed) and add any necessary environment variables.

Dependencies

All required packages are defined in pyproject.toml. You can install them using the following command:

uv pip install -e .

Running the Server

To run manually in the terminal:

uv pip install -e .  # Ensure installation
python main.py

Or if using a virtual environment:

.venv/Scripts/python.exe main.py

💻 Usage Examples

Integrating with Claude Desktop

To use this server with Claude Desktop, configure your claude_desktop_config.json as follows:

{
  "mcpServers": {
    "omni_server": {
      "command": "<Project Path>/.venv/Scripts/python.exe",
      "args": [
        "<Project Path>/main.py"
      ],
      "cwd": "<Project Path>"
    }
  }
}

Ensure that:

• The path to the Python executable is correct.
• Your virtual environment (.venv) is created and installed via uv.
• Claude Desktop can recognize the MCP server. After configuration, Omni Server will run as the backend for Claude Desktop, supporting the MCP protocol!

🤝 Contribution

Contributions are welcome! Fork the repository, make changes, and submit a Pull Request.

📄 License

This project is licensed under the MIT License. For more details, please refer to the LICENSE file.