article
README
🚀 MCP 服务器
MCP 服务器是一个基于 FastAPI 构建的服务器,它具备强大的 WebSocket 通信、文件管理以及工具端点功能,能有效解决文件管理、实时通信等问题,为用户提供便捷的服务。
🚀 快速开始
MCP 服务器提供了文件管理、WebSocket 通信等功能。你可以按照以下步骤安装并运行服务器。
✨ 主要特性
- 📁 文件管理 API:方便对文件进行管理和操作。
- 🔌 WebSocket 通信:实现实时通信功能。
- 🛠️ 工具端点:提供工具执行功能,如摘要功能。
- 📄 静态文件服务:可提供静态文件的访问。
- ✅ 全面测试套件:确保服务器的稳定性和可靠性。
📦 安装指南
- 克隆仓库:
git clone https://github.com/khaosans/mcp-server.git
cd mcp-server
- 创建并激活虚拟环境:
python -m venv venv
source venv/bin/activate # 在 Windows 中:.\venv\Scripts\activate
- 安装依赖项:
pip install -r requirements.txt
💻 使用示例
基础用法
启动服务器:
uvicorn server:app --reload --host 0.0.0.0 --port 8080
运行测试套件:
python test_server.py
📚 详细文档
📡 API 端点
HTTP 端点
GET /files?q=<查询>:在公共目录中搜索文件。GET /files/{filename}:读取特定文件。POST /tools:执行工具(当前支持摘要功能)。GET /public/*:提供静态文件服务。
WebSocket 端点
ws://localhost:8080/ws:实时通信的 WebSocket 端点。
📄 许可证
本项目采用 MIT License。
Scan to join WeChat group