South Asia

🚀 南亞地區 MCP 工具

這是一個基於 MCP (Model Control Protocol) 框架的工具開發模板，可幫助開發者快速搭建相關工具。

🚀 快速開始

工具名稱配置

如果您想要更改工具名稱（默認為 "southAsia"），需要修改以下位置：

1. src/southasia/server.py 中的常量配置：

MCP_TOOL_NAME = "southAsia"  # 更改此處以修改工具名稱

2. pyproject.toml 中的命令行工具名稱（使用小寫）：

[project.scripts]
southasia = "southasia.server:main"  # 更改 "southasia" 為您想要的名稱

3. Cursor 配置文件中的工具名稱：

{
    "tools": {
        "southAsia": {
            "command": "python -m southasia.server"
        }
    }
}

安裝與配置

創建和激活虛擬環境（可選）

在 Windows 上使用 PowerShell 或命令提示符：

1. 進入項目目錄：

cd your_project_directory

2. 創建並激活虛擬環境：

python -m venv myenv
.\myenv\Scripts\activate.ps1  # 在 PowerShell 中使用

安裝開發版本

在項目根目錄運行以下命令：

pip install -e .

配置 Cursor

編輯或創建 config.json 文件（通常位於 %USERPROFILE%\.cursor\mcp.json），添加以下內容：

{
    "tools": {
        "southasia": {
            "command": "python -m southasia.server"
        }
    }
}

運行服務器

使用命令運行：

southasia  # 如果已安裝為可執行文件
# 或者
python -m southasia.server

測試

使用以下命令測試工具：

@southasia hello_world

💻 使用示例

基礎用法

src/southasia/handlers/hello_world.py 提供了一個示例，展示如何：

定義工具列表：

def handle_list_tools():
    return [{
        "name": "hello_world",
        "description": "返回 'Hello, World!' 消息"
    }]

處理調用：

async def handle_call_tool(tool_name, params):
    if tool_name == "hello_world":
        return "Hello, World!"
    raise ValueError(f"未知工具名稱: {tool_name}")

📚 詳細文檔

開發新功能

參考 Tool_GUIDE.md 獲取詳細指南，主要步驟包括：

1. 在 handlers/ 目錄下創建新的處理器文件。
2. 實現工具列表定義（handle_list_tools）和調用處理（handle_call_tool）。
3. 在 server.py 中導入並註冊新工具。

⚠️ 注意事項

⚠️ 重要提示

• 所有更改需重啟服務器生效。
• 確保在虛擬環境中開發以避免環境衝突。
• 遵循模塊化結構和代碼風格，添加適當註釋和錯誤處理。

📄 相關文件

• Tool_GUIDE.md：詳細工具開發指南
• src/southasia/handlers/hello_world.py：示例工具實現
• src/southasia/server.py：服務器配置與工具註冊