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：服务器配置与工具注册