MCP Server Template (python)

🚀 MCP 服務器模板（Python）

這是一個現成的模板，可用於快速構建模型上下文協議（MCP）服務器。藉助該模板，您能夠迅速創建可註冊和暴露工具與提示的服務器，供 AI 模型使用。

📚 目錄

• 快速開始
• 命令行選項
• 創建自己的工具和提示
• 項目結構
• 部署選項
• 開發指南
• 需要幫助？

🚀 快速開始

先決條件

• Python 3.10 或更高版本

三步快速設置

1️⃣ 安裝包

# 克隆倉庫
git clone https://github.com/nisarg38/mcp-server-template-python.git my-mcp-server
cd my-mcp-server

# 以開發模式安裝
pip install -e ".[dev]"

2️⃣ 運行您的服務器

# 使用 Python 運行
python -m src.main

# 或使用方便的 CLI
mcp-server-template

3️⃣ 您的服務器現已啟動！

訪問您的 MCP 服務器：

• 🌐 HTTP：http://localhost:8080
• 💻 或使用 stdio 運輸：mcp-server-template --transport stdio

您會看到日誌輸出，確認服務器成功運行。

🎮 命令行選項

通過這些命令行選項自定義您的服務器行為：

# 更改端口（默認：8080）
mcp-server-template --port 9000

# 啟用調試模式以獲得更詳細的日誌
mcp-server-template --debug

# 使用 stdio 運輸而不是 HTTP
mcp-server-template --transport stdio

# 設置日誌級別（選項：debug, info, warning, error）
mcp-server-template --log-level debug

🛠️ 創建自己的工具和提示

添加一個工具

工具是 AI 模型可以調用的函數。要添加新的工具：

1. 編輯 src/main.py
2. 使用 @mcp.tool() 裝飾器添加新函數：

@mcp.tool()
def your_tool_name(param1: str, param2: int) -> Dict[str, Any]:
    """
    示例：在此處添加工具的描述。

    Args:
        param1: 描述參數 1。
        param2: 描述參數 2。

    Returns:
        返回值的描述。
    """

添加一個提示

提示是模型可以用來生成響應的字符串。要添加新的提示：

1. 編輯 src/main.py
2. 使用 @mcp.prompt() 裝飾器添加新函數：

@mcp.prompt()
def your_prompt_name() -> str:
    """
    示例：在此處添加提示描述。
    """

💻 使用示例

基礎用法

# 示例工具
@mcp.tool()
def add_numbers(param1: float, param2: float) -> float:
    """
    Args:
        param1: 第一個數字。
        param2: 第二個數字。

    Returns:
        兩個數字的和。
    """
    return param1 + param2

# 示例提示
@mcp.prompt()
def math_prompt() -> str:
    """
    Returns:
        "請計算這兩個數字的和。"
    """

📦 項目結構

your_project/
├── src/
│   ├── main.py         # MCP 服務器主文件
│   └── prompts.py      # 定義提示的地方
└── requirements.txt   # 必要的依賴項列表

💻 部署選項

基於 Web 的界面

您可以使用 FastAPI 或 Flask 創建一個簡單的基於 Web 的界面來與 MCP 服務器交互。

打包和部署

使用 setuptools 將您的 MCP 服務器打包為一個獨立的可執行文件，然後部署到生產環境中。

🛠️ 開發指南

安裝依賴項

在 requirements.txt 中列出所有必要的庫，並運行：

pip install -r requirements.txt

測試和調試

編寫單元測試來驗證您的工具和提示是否按預期工作，然後使用日誌記錄和調試信息進行故障排除。

🤝 需要幫助？

• 提問：在 GitHub 上提出問題。
• 交流：加入我們的 Discord 社區（即將推出）。

由 ❤️ 製作，獻給 AI 開發者社區