Code MCP Server

🚀 MCP 服務器

MCP 服務器基於 FastAPI 實現了 Model-Controller-Provider (MCP) 架構。它能高效處理業務邏輯，藉助現代技術棧，為開發者提供便捷的 API 開發體驗。

🚀 快速開始

環境搭建

1. 創建 Conda 環境：

# 創建一個名為 codeMcpServer 的新環境，使用 Python 3.12
conda create -n codeMcpServer python=3.12
# 激活環境
conda activate codeMcpServer

2. 安裝依賴：

# 使用提供的環境文件（推薦）
conda env create -f environment.yml

# 或者使用 pip 
pip install -r requirements.txt

# 或者使用 conda 與 conda-forge 通道
conda config --add channels conda-forge
conda install --file requirements.txt

3. 運行服務器：

uvicorn main:app --reload

服務器將在 http://localhost:8000 啟動

開發環境啟動

1. 克隆倉庫：

git clone [倉庫地址]
cd mcp-server

2. 創建並激活 Conda 環境：

conda create -n mcp_env python=3.8
conda activate mcp_env

3. 安裝依賴：

pip install -r requirements.txt

4. 啟動服務器：

python main.py

✨ 主要特性

• 基於 FastAPI 的 REST API：高性能、易於使用、快速編碼
• MCP 架構：
  • 模型：數據結構和數據庫模式
  • 控制器：業務邏輯和請求處理
  • 提供者：數據訪問和外部服務集成
• 現代技術堆棧：
  • SQLAlchemy 用於 ORM
  • Pydantic 用於數據驗證
  • FastAPI 用於 API 框架
  • SQLite 用於開發數據庫
• API 特性：
  • 自動 OpenAPI 文檔
  • 請求驗證
  • 響應序列化
  • CORS 中間件
  • 類型檢查

📦 安裝指南

依賴安裝

項目中的關鍵依賴項：

• Python 3.12.9
• FastAPI 0.112.2
• SQLAlchemy 2.0.37
• Pydantic 2.11.2
• Uvicorn 0.32.1
• Python-dotenv 0.21.0

完整的依賴列表請查看 environment.yml 或 requirements.txt。

環境管理

導出環境

要導出當前環境以便共享：

# 導出完整環境（無前綴）以獲取精確版本
conda env export | grep -v '^prefix' > environment.yml

# 或者僅導出依賴項
conda list --export > requirements.txt

導入環境

要導入現有環境文件：

# 使用 Conda 環境文件
conda env create -f environment.yml

# 或者使用 pip 要求文件
pip install -r requirements.txt

📚 詳細文檔

請參閱項目中的 docs 目錄，瞭解完整的 API 文檔和實現細節。

API 文檔

完整的 API 文檔可以在以下鏈接查閱：

• Swagger UI: http://localhost:8000/docs
• ReDoc: http://localhost:8000/redoc

🔧 技術細節

項目結構

.
├── api/              # API 路由和端點
│   └── v1/          # API 版本 1
│       ├── __init__.py
│       └── items.py # 項目端點
├── controllers/      # 業務邏輯和請求處理程序
│   └── item_controller.py
├── providers/       # 數據訪問和外部服務集成
│   └── item_provider.py
├── models/         # 數據模型和數據庫模式
│   └── item.py
├── core/          # 核心配置和工具
│   ├── config.py  # 應用程序配置
│   └── database.py # 數據庫配置
├── main.py        # 應用程序入口點
├── requirements.txt # 項目依賴
├── environment.yml  # Conda 環境文件
└── README.md      # 項目文檔

開發時遵循的項目結構：

.
├── src/           # 核心代碼
│   ├── MCP/
│   │   ├── controllers/     # 請求處理邏輯
│   │   ├── providers/       # 數據訪問邏輯
│   │   └── models/          # 數據模型定義
│   ├── config.py            # 應用程序配置
│   └── database.py          # 數據庫連接配置
├── main.py        # 應用程序入口點
├── requirements.txt # 項目依賴
└── README.md      # 項目文檔

🤝 貢獻

提交代碼

在提交代碼之前，請確保：

1. 運行所有測試用例並確保其通過：

pytest tests/

2. 確保代碼符合項目編碼規範。
3. 更新相關的文檔和註釋。
4. 創建清晰且具有描述性的提交信息。

問題報告

請在 GitHub 倉庫中創建一個問題，描述詳細的問題信息。

📄 許可證

該項目受 MIT License 許可保護。