South Asia

🚀 South Asia MCP Tool

This is a tool development template based on the MCP (Model Control Protocol) framework. It provides a structured way to develop and customize tools using the MCP framework.

🚀 Quick Start

Tool Name Configuration

If you want to change the tool name (default is "southAsia"), you need to modify the following locations:

1. Constant configuration in src/southasia/server.py:

MCP_TOOL_NAME = "southAsia"  # Change this to modify the tool name

2. Command-line tool name in pyproject.toml (use lowercase):

[project.scripts]
southasia = "southasia.server:main"  # Change "southasia" to your desired name

3. Tool name in the Cursor configuration file:

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

Installation and Configuration

Create and activate a virtual environment (optional)

On Windows using PowerShell or Command Prompt:

1. Navigate to the project directory:

cd your_project_directory

2. Create and activate the virtual environment:

python -m venv myenv
.\myenv\Scripts\activate.ps1  # Use in PowerShell

Install the development version

Run the following command in the project root directory:

pip install -e .

Configure Cursor

Edit or create the config.json file (usually located at %USERPROFILE%\.cursor\mcp.json) and add the following content:

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

Run the Server

Run using the command:

southasia  # If installed as an executable
# Or
python -m southasia.server

Testing

Test the tool using the following command:

@southasia hello_world

💻 Usage Examples

Basic Usage

The src/southasia/handlers/hello_world.py file provides an example showing how to:

Define the tool list

def handle_list_tools():
    return [{
        "name": "hello_world",
        "description": "Return a 'Hello, World!' message"
    }]

Handle calls

async def handle_call_tool(tool_name, params):
    if tool_name == "hello_world":
        return "Hello, World!"
    raise ValueError(f"Unknown tool name: {tool_name}")

🚧 Development of New Features

Refer to Tool_GUIDE.md for detailed guidelines. The main steps include:

1. Create a new handler file in the handlers/ directory.
2. Implement the tool list definition (handle_list_tools) and call handling (handle_call_tool).
3. Import and register the new tool in server.py.

📚 Documentation

Related Files

• Tool_GUIDE.md: Detailed tool development guide
• src/southasia/handlers/hello_world.py: Example tool implementation
• src/southasia/server.py: Server configuration and tool registration

⚠️ Important Note

• All changes require restarting the server to take effect.
• Ensure development is done in a virtual environment to avoid environment conflicts.
• Follow the modular structure and code style, and add appropriate comments and error handling.