Shieldmcp

🚀 MCP安全護盾

MCP安全護盾是一款中間件，它能夠增強Model Context Protocol (MCP) 服務器的安全性與監控能力，且無需修改官方SDK。此工具包提供了保護和監控MCP工具調用的實用工具，遵循MCP文檔中提及的最佳實踐，可在不暴露自身的情況下與MCP開發進行交互。

🚀 快速開始

要使用Shield MCP，首先需要安裝庫：

pip install shieldmcp

然後按照以下步驟配置和使用：

1. 初始化ShieldMCP實例：

from shieldmcp import ShieldMCP

shield = ShieldMCP()

2. 配置訪問控制：

shield.set_allowed_tools(["tool1", "tool2"])

3. 啟用結果清理功能：

shield.enable_output_cleaning(patterns=[r"\b信用卡號\b"], max_length=500)

4. 使用ShieldMCP處理請求：

response = shield.process_request(request_data)

✨ 主要特性

• 工具訪問控制：基於白名單的MCP工具訪問控制
• 結果清理：可配置的結果輸出清理功能
• 結構化日誌記錄：使用structlog的全面審計日誌記錄
• 速率限制：令牌桶算法實現的速率限制
• 錯誤處理：標準化錯誤處理和格式化
• MCP Inspector兼容：與MCP Inspector工具無縫協作

📦 安裝指南

from shieldmcp import ShieldMCP

📚 詳細文檔

需求

系統需求

• Python 3.8 或更高版本
• pip（Python 包安裝程序）
• virtualenv（開發推薦）

組件

裝飾器 (decorators.py)

提供用於保護MCP端點的裝飾器：

from shieldmcp.decorators import shield_mcp_endpoint

@shield_mcp_endpoint
def protected_endpoint(data):
    # 處理請求
    return response

日誌記錄 (logging.py)

集成結構化日誌記錄到你的應用中：

from shieldmcp.logging import setup_logging

setup_logging("info")
logger.info("處理開始")

最佳實踐

工具訪問控制

• 始終定義允許工具的白名單。
• 定期審查和更新白名單。

結果清理

• 清理所有文本輸出。
• 定義敏感數據模式。
• 設置合理的長度限制。

日誌記錄

• 在可用時包含用戶和會話ID。
• 記錄成功和失敗的操作。
• 使用結構化日誌以備更好地分析。

速率限制

• 根據工具複雜性設置適當的限制。
• 考慮突發大小以提升用戶體驗。
• 監控速率限制觸發情況。

開發

設置開發環境

# 克隆倉庫
git clone https://github.com/shieldmcp/shieldmcp.git
cd shieldmcp

# 創建虛擬環境
python -m venv venv
source venv/bin/activate  # 或 `venv\Scripts\activate` 在 Windows 上

# 安裝開發依賴項
pip install -r requirements.txt

運行測試

pytest tests/

路線圖

計劃功能

• 支持Clerk MCP 和 Github MCP。
• 擴展文檔。
• TypeScript 支持。

致謝

• Model Context Protocol 提供協議規範。
• structlog 用於結構化日誌記錄。