🚀 Omni Server

Omni Server 是一个基于 Model Context Protocol (MCP) 的服务器实现，旨在帮助开发者熟悉 MCP 框架。它作为基础工具，为理解和实施基于 MCP 的应用程序提供支持。

✨ 主要特性

• 🚀 采用 Python 实现的 MCP 服务器。
• 📁 项目结构模块化，数据文件、提示模板、工具和资源清晰分离。
• ⚙️ 支持通过 .env 和 Poetry 进行灵活配置。
• 🧠 与 Claude Desktop 实现无缝集成。

📦 安装指南

前提条件

• Python 3.8 或更高版本。
• uv 用于依赖管理。

安装步骤

1. 克隆仓库：

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

2. 使用 uv 安装依赖项：

uv venv
uv pip install -r requirements.txt  # 如果使用 requirements.txt

# 或者更好的方式：
uv pip install -e .  # 如果使用 pyproject.toml

3. 激活虚拟环境（如果需要）：

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

4. 创建 .env 文件（如果有需要），添加任何必要的环境变量。

💻 使用示例

运行服务器

手动运行

要在终端手动运行：

uv pip install -e .  # 确保已安装
python main.py

使用虚拟环境运行

如果使用虚拟环境：

.venv/Scripts/python.exe main.py

与 Claude Desktop 集成

要将此服务器与 Claude Desktop 结合使用，请配置你的 claude_desktop_config.json 如下：

{
  "mcpServers": {
    "omni_server": {
      "command": "<项目路径>/.venv/Scripts/python.exe",
      "args": [
        "<项目路径>/main.py"
      ],
      "cwd": "<项目路径>"
    }
  }
}

确保：

• Python 可执行文件的路径正确。
• 你的虚拟环境 (.venv) 已创建并通过 uv 安装。
• Claude Desktop 能够识别 MCP 服务器。

配置完成后，Omni Server 将作为 Claude Desktop 的后端运行，支持 MCP 协议！

📚 详细文档

项目结构

omni-server/
├── data/           # 数据文件和数据集
├── prompts/        # 提示模板及相关文件
├── resources/      # 静态资源和资产
├── tools/          # 工具脚本和实用程序
├── utils/          # 辅助函数和工具
├── .env            # 环境变量定义
├── .gitignore      # Git 忽略规则
├── .python-version # Python 版本指定
├── README.md       # 项目文档
├── main.py         # 应用程序入口点
├── pyproject.toml  # 项目元数据和依赖项
├── server.py       # 服务器初始化和配置
└── uv.lock         # 依赖锁定文件

依赖项

所有必需的包都定义在 pyproject.toml 中。可以使用以下命令安装：

uv pip install -e .

🤝 贡献

欢迎贡献！ Fork 仓库，在上面进行更改并提交 Pull Request。

📄 许可证

此项目 licensed under the MIT License。有关详细信息，请参阅 LICENSE 文件。